777bc06bfb882745545c3db089c2f918a43c9b95
[rust-lightning] / lightning / src / chain / channelmonitor.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
8 // licenses.
9
10 //! The logic to monitor for on-chain transactions and create the relevant claim responses lives
11 //! here.
12 //!
13 //! ChannelMonitor objects are generated by ChannelManager in response to relevant
14 //! messages/actions, and MUST be persisted to disk (and, preferably, remotely) before progress can
15 //! be made in responding to certain messages, see [`chain::Watch`] for more.
16 //!
17 //! Note that ChannelMonitors are an important part of the lightning trust model and a copy of the
18 //! latest ChannelMonitor must always be actively monitoring for chain updates (and no out-of-date
19 //! ChannelMonitors should do so). Thus, if you're building rust-lightning into an HSM or other
20 //! security-domain-separated system design, you should consider having multiple paths for
21 //! ChannelMonitors to get out of the HSM and onto monitoring devices.
22
23 use bitcoin::blockdata::block::{Block, BlockHeader};
24 use bitcoin::blockdata::transaction::{TxOut,Transaction};
25 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
26 use bitcoin::blockdata::script::{Script, Builder};
27 use bitcoin::blockdata::opcodes;
28
29 use bitcoin::hashes::Hash;
30 use bitcoin::hashes::sha256::Hash as Sha256;
31 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
32
33 use bitcoin::secp256k1::{Secp256k1,Signature};
34 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
35 use bitcoin::secp256k1;
36
37 use ln::msgs::DecodeError;
38 use ln::chan_utils;
39 use ln::chan_utils::{CounterpartyCommitmentSecrets, HTLCOutputInCommitment, HTLCType, ChannelTransactionParameters, HolderCommitmentTransaction};
40 use ln::channelmanager::{BestBlock, HTLCSource, PaymentPreimage, PaymentHash};
41 use ln::onchaintx::{OnchainTxHandler, InputDescriptors};
42 use chain;
43 use chain::WatchedOutput;
44 use chain::chaininterface::{BroadcasterInterface, FeeEstimator};
45 use chain::transaction::{OutPoint, TransactionData};
46 use chain::keysinterface::{SpendableOutputDescriptor, StaticPaymentOutputDescriptor, DelayedPaymentOutputDescriptor, Sign, KeysInterface};
47 use chain::Filter;
48 use util::logger::Logger;
49 use util::ser::{Readable, ReadableArgs, MaybeReadable, Writer, Writeable, U48};
50 use util::byte_utils;
51 use util::events::Event;
52
53 use std::collections::{HashMap, HashSet};
54 use std::{cmp, mem};
55 use std::io::Error;
56 use std::ops::Deref;
57 use std::sync::Mutex;
58
59 /// An update generated by the underlying Channel itself which contains some new information the
60 /// ChannelMonitor should be made aware of.
61 #[cfg_attr(any(test, feature = "fuzztarget", feature = "_test_utils"), derive(PartialEq))]
62 #[derive(Clone)]
63 #[must_use]
64 pub struct ChannelMonitorUpdate {
65         pub(crate) updates: Vec<ChannelMonitorUpdateStep>,
66         /// The sequence number of this update. Updates *must* be replayed in-order according to this
67         /// sequence number (and updates may panic if they are not). The update_id values are strictly
68         /// increasing and increase by one for each new update, with one exception specified below.
69         ///
70         /// This sequence number is also used to track up to which points updates which returned
71         /// ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
72         /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
73         ///
74         /// The only instance where update_id values are not strictly increasing is the case where we
75         /// allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
76         /// its docs for more details.
77         pub update_id: u64,
78 }
79
80 /// If:
81 ///    (1) a channel has been force closed and
82 ///    (2) we receive a preimage from a forward link that allows us to spend an HTLC output on
83 ///        this channel's (the backward link's) broadcasted commitment transaction
84 /// then we allow the `ChannelManager` to send a `ChannelMonitorUpdate` with this update ID,
85 /// with the update providing said payment preimage. No other update types are allowed after
86 /// force-close.
87 pub const CLOSED_CHANNEL_UPDATE_ID: u64 = std::u64::MAX;
88
89 impl Writeable for ChannelMonitorUpdate {
90         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
91                 self.update_id.write(w)?;
92                 (self.updates.len() as u64).write(w)?;
93                 for update_step in self.updates.iter() {
94                         update_step.write(w)?;
95                 }
96                 Ok(())
97         }
98 }
99 impl Readable for ChannelMonitorUpdate {
100         fn read<R: ::std::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
101                 let update_id: u64 = Readable::read(r)?;
102                 let len: u64 = Readable::read(r)?;
103                 let mut updates = Vec::with_capacity(cmp::min(len as usize, MAX_ALLOC_SIZE / ::std::mem::size_of::<ChannelMonitorUpdateStep>()));
104                 for _ in 0..len {
105                         updates.push(Readable::read(r)?);
106                 }
107                 Ok(Self { update_id, updates })
108         }
109 }
110
111 /// An error enum representing a failure to persist a channel monitor update.
112 #[derive(Clone, Debug)]
113 pub enum ChannelMonitorUpdateErr {
114         /// Used to indicate a temporary failure (eg connection to a watchtower or remote backup of
115         /// our state failed, but is expected to succeed at some point in the future).
116         ///
117         /// Such a failure will "freeze" a channel, preventing us from revoking old states or
118         /// submitting new commitment transactions to the counterparty. Once the update(s) which failed
119         /// have been successfully applied, ChannelManager::channel_monitor_updated can be used to
120         /// restore the channel to an operational state.
121         ///
122         /// Note that a given ChannelManager will *never* re-generate a given ChannelMonitorUpdate. If
123         /// you return a TemporaryFailure you must ensure that it is written to disk safely before
124         /// writing out the latest ChannelManager state.
125         ///
126         /// Even when a channel has been "frozen" updates to the ChannelMonitor can continue to occur
127         /// (eg if an inbound HTLC which we forwarded was claimed upstream resulting in us attempting
128         /// to claim it on this channel) and those updates must be applied wherever they can be. At
129         /// least one such updated ChannelMonitor must be persisted otherwise PermanentFailure should
130         /// be returned to get things on-chain ASAP using only the in-memory copy. Obviously updates to
131         /// the channel which would invalidate previous ChannelMonitors are not made when a channel has
132         /// been "frozen".
133         ///
134         /// Note that even if updates made after TemporaryFailure succeed you must still call
135         /// channel_monitor_updated to ensure you have the latest monitor and re-enable normal channel
136         /// operation.
137         ///
138         /// Note that the update being processed here will not be replayed for you when you call
139         /// ChannelManager::channel_monitor_updated, so you must store the update itself along
140         /// with the persisted ChannelMonitor on your own local disk prior to returning a
141         /// TemporaryFailure. You may, of course, employ a journaling approach, storing only the
142         /// ChannelMonitorUpdate on disk without updating the monitor itself, replaying the journal at
143         /// reload-time.
144         ///
145         /// For deployments where a copy of ChannelMonitors and other local state are backed up in a
146         /// remote location (with local copies persisted immediately), it is anticipated that all
147         /// updates will return TemporaryFailure until the remote copies could be updated.
148         TemporaryFailure,
149         /// Used to indicate no further channel monitor updates will be allowed (eg we've moved on to a
150         /// different watchtower and cannot update with all watchtowers that were previously informed
151         /// of this channel).
152         ///
153         /// At reception of this error, ChannelManager will force-close the channel and return at
154         /// least a final ChannelMonitorUpdate::ChannelForceClosed which must be delivered to at
155         /// least one ChannelMonitor copy. Revocation secret MUST NOT be released and offchain channel
156         /// update must be rejected.
157         ///
158         /// This failure may also signal a failure to update the local persisted copy of one of
159         /// the channel monitor instance.
160         ///
161         /// Note that even when you fail a holder commitment transaction update, you must store the
162         /// update to ensure you can claim from it in case of a duplicate copy of this ChannelMonitor
163         /// broadcasts it (e.g distributed channel-monitor deployment)
164         ///
165         /// In case of distributed watchtowers deployment, the new version must be written to disk, as
166         /// state may have been stored but rejected due to a block forcing a commitment broadcast. This
167         /// storage is used to claim outputs of rejected state confirmed onchain by another watchtower,
168         /// lagging behind on block processing.
169         PermanentFailure,
170 }
171
172 /// General Err type for ChannelMonitor actions. Generally, this implies that the data provided is
173 /// inconsistent with the ChannelMonitor being called. eg for ChannelMonitor::update_monitor this
174 /// means you tried to update a monitor for a different channel or the ChannelMonitorUpdate was
175 /// corrupted.
176 /// Contains a developer-readable error message.
177 #[derive(Clone, Debug)]
178 pub struct MonitorUpdateError(pub &'static str);
179
180 /// An event to be processed by the ChannelManager.
181 #[derive(Clone, PartialEq)]
182 pub enum MonitorEvent {
183         /// A monitor event containing an HTLCUpdate.
184         HTLCEvent(HTLCUpdate),
185
186         /// A monitor event that the Channel's commitment transaction was broadcasted.
187         CommitmentTxBroadcasted(OutPoint),
188 }
189
190 /// Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
191 /// chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
192 /// preimage claim backward will lead to loss of funds.
193 #[derive(Clone, PartialEq)]
194 pub struct HTLCUpdate {
195         pub(crate) payment_hash: PaymentHash,
196         pub(crate) payment_preimage: Option<PaymentPreimage>,
197         pub(crate) source: HTLCSource
198 }
199 impl_writeable!(HTLCUpdate, 0, { payment_hash, payment_preimage, source });
200
201 /// If an HTLC expires within this many blocks, don't try to claim it in a shared transaction,
202 /// instead claiming it in its own individual transaction.
203 pub(crate) const CLTV_SHARED_CLAIM_BUFFER: u32 = 12;
204 /// If an HTLC expires within this many blocks, force-close the channel to broadcast the
205 /// HTLC-Success transaction.
206 /// In other words, this is an upper bound on how many blocks we think it can take us to get a
207 /// transaction confirmed (and we use it in a few more, equivalent, places).
208 pub(crate) const CLTV_CLAIM_BUFFER: u32 = 6;
209 /// Number of blocks by which point we expect our counterparty to have seen new blocks on the
210 /// network and done a full update_fail_htlc/commitment_signed dance (+ we've updated all our
211 /// copies of ChannelMonitors, including watchtowers). We could enforce the contract by failing
212 /// at CLTV expiration height but giving a grace period to our peer may be profitable for us if he
213 /// can provide an over-late preimage. Nevertheless, grace period has to be accounted in our
214 /// CLTV_EXPIRY_DELTA to be secure. Following this policy we may decrease the rate of channel failures
215 /// due to expiration but increase the cost of funds being locked longuer in case of failure.
216 /// This delay also cover a low-power peer being slow to process blocks and so being behind us on
217 /// accurate block height.
218 /// In case of onchain failure to be pass backward we may see the last block of ANTI_REORG_DELAY
219 /// with at worst this delay, so we are not only using this value as a mercy for them but also
220 /// us as a safeguard to delay with enough time.
221 pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
222 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding inbound
223 /// HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us losing money.
224 /// We use also this delay to be sure we can remove our in-flight claim txn from bump candidates buffer.
225 /// It may cause spurrious generation of bumped claim txn but that's allright given the outpoint is already
226 /// solved by a previous claim tx. What we want to avoid is reorg evicting our claim tx and us not
227 /// keeping bumping another claim tx to solve the outpoint.
228 pub(crate) const ANTI_REORG_DELAY: u32 = 6;
229 /// Number of blocks before confirmation at which we fail back an un-relayed HTLC or at which we
230 /// refuse to accept a new HTLC.
231 ///
232 /// This is used for a few separate purposes:
233 /// 1) if we've received an MPP HTLC to us and it expires within this many blocks and we are
234 ///    waiting on additional parts (or waiting on the preimage for any HTLC from the user), we will
235 ///    fail this HTLC,
236 /// 2) if we receive an HTLC within this many blocks of its expiry (plus one to avoid a race
237 ///    condition with the above), we will fail this HTLC without telling the user we received it,
238 /// 3) if we are waiting on a connection or a channel state update to send an HTLC to a peer, and
239 ///    that HTLC expires within this many blocks, we will simply fail the HTLC instead.
240 ///
241 /// (1) is all about protecting us - we need enough time to update the channel state before we hit
242 /// CLTV_CLAIM_BUFFER, at which point we'd go on chain to claim the HTLC with the preimage.
243 ///
244 /// (2) is the same, but with an additional buffer to avoid accepting an HTLC which is immediately
245 /// in a race condition between the user connecting a block (which would fail it) and the user
246 /// providing us the preimage (which would claim it).
247 ///
248 /// (3) is about our counterparty - we don't want to relay an HTLC to a counterparty when they may
249 /// end up force-closing the channel on us to claim it.
250 pub(crate) const HTLC_FAIL_BACK_BUFFER: u32 = CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS;
251
252 // TODO(devrandom) replace this with HolderCommitmentTransaction
253 #[derive(Clone, PartialEq)]
254 struct HolderSignedTx {
255         /// txid of the transaction in tx, just used to make comparison faster
256         txid: Txid,
257         revocation_key: PublicKey,
258         a_htlc_key: PublicKey,
259         b_htlc_key: PublicKey,
260         delayed_payment_key: PublicKey,
261         per_commitment_point: PublicKey,
262         feerate_per_kw: u32,
263         htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
264 }
265
266 /// We use this to track counterparty commitment transactions and htlcs outputs and
267 /// use it to generate any justice or 2nd-stage preimage/timeout transactions.
268 #[derive(PartialEq)]
269 struct CounterpartyCommitmentTransaction {
270         counterparty_delayed_payment_base_key: PublicKey,
271         counterparty_htlc_base_key: PublicKey,
272         on_counterparty_tx_csv: u16,
273         per_htlc: HashMap<Txid, Vec<HTLCOutputInCommitment>>
274 }
275
276 impl Writeable for CounterpartyCommitmentTransaction {
277         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
278                 self.counterparty_delayed_payment_base_key.write(w)?;
279                 self.counterparty_htlc_base_key.write(w)?;
280                 w.write_all(&byte_utils::be16_to_array(self.on_counterparty_tx_csv))?;
281                 w.write_all(&byte_utils::be64_to_array(self.per_htlc.len() as u64))?;
282                 for (ref txid, ref htlcs) in self.per_htlc.iter() {
283                         w.write_all(&txid[..])?;
284                         w.write_all(&byte_utils::be64_to_array(htlcs.len() as u64))?;
285                         for &ref htlc in htlcs.iter() {
286                                 htlc.write(w)?;
287                         }
288                 }
289                 Ok(())
290         }
291 }
292 impl Readable for CounterpartyCommitmentTransaction {
293         fn read<R: ::std::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
294                 let counterparty_commitment_transaction = {
295                         let counterparty_delayed_payment_base_key = Readable::read(r)?;
296                         let counterparty_htlc_base_key = Readable::read(r)?;
297                         let on_counterparty_tx_csv: u16 = Readable::read(r)?;
298                         let per_htlc_len: u64 = Readable::read(r)?;
299                         let mut per_htlc = HashMap::with_capacity(cmp::min(per_htlc_len as usize, MAX_ALLOC_SIZE / 64));
300                         for _  in 0..per_htlc_len {
301                                 let txid: Txid = Readable::read(r)?;
302                                 let htlcs_count: u64 = Readable::read(r)?;
303                                 let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
304                                 for _ in 0..htlcs_count {
305                                         let htlc = Readable::read(r)?;
306                                         htlcs.push(htlc);
307                                 }
308                                 if let Some(_) = per_htlc.insert(txid, htlcs) {
309                                         return Err(DecodeError::InvalidValue);
310                                 }
311                         }
312                         CounterpartyCommitmentTransaction {
313                                 counterparty_delayed_payment_base_key,
314                                 counterparty_htlc_base_key,
315                                 on_counterparty_tx_csv,
316                                 per_htlc,
317                         }
318                 };
319                 Ok(counterparty_commitment_transaction)
320         }
321 }
322
323 /// When ChannelMonitor discovers an onchain outpoint being a step of a channel and that it needs
324 /// to generate a tx to push channel state forward, we cache outpoint-solving tx material to build
325 /// a new bumped one in case of lenghty confirmation delay
326 #[derive(Clone, PartialEq)]
327 pub(crate) enum InputMaterial {
328         Revoked {
329                 per_commitment_point: PublicKey,
330                 counterparty_delayed_payment_base_key: PublicKey,
331                 counterparty_htlc_base_key: PublicKey,
332                 per_commitment_key: SecretKey,
333                 input_descriptor: InputDescriptors,
334                 amount: u64,
335                 htlc: Option<HTLCOutputInCommitment>,
336                 on_counterparty_tx_csv: u16,
337         },
338         CounterpartyHTLC {
339                 per_commitment_point: PublicKey,
340                 counterparty_delayed_payment_base_key: PublicKey,
341                 counterparty_htlc_base_key: PublicKey,
342                 preimage: Option<PaymentPreimage>,
343                 htlc: HTLCOutputInCommitment
344         },
345         HolderHTLC {
346                 preimage: Option<PaymentPreimage>,
347                 amount: u64,
348         },
349         Funding {
350                 funding_redeemscript: Script,
351         }
352 }
353
354 impl Writeable for InputMaterial  {
355         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
356                 match self {
357                         &InputMaterial::Revoked { ref per_commitment_point, ref counterparty_delayed_payment_base_key, ref counterparty_htlc_base_key, ref per_commitment_key, ref input_descriptor, ref amount, ref htlc, ref on_counterparty_tx_csv} => {
358                                 writer.write_all(&[0; 1])?;
359                                 per_commitment_point.write(writer)?;
360                                 counterparty_delayed_payment_base_key.write(writer)?;
361                                 counterparty_htlc_base_key.write(writer)?;
362                                 writer.write_all(&per_commitment_key[..])?;
363                                 input_descriptor.write(writer)?;
364                                 writer.write_all(&byte_utils::be64_to_array(*amount))?;
365                                 htlc.write(writer)?;
366                                 on_counterparty_tx_csv.write(writer)?;
367                         },
368                         &InputMaterial::CounterpartyHTLC { ref per_commitment_point, ref counterparty_delayed_payment_base_key, ref counterparty_htlc_base_key, ref preimage, ref htlc} => {
369                                 writer.write_all(&[1; 1])?;
370                                 per_commitment_point.write(writer)?;
371                                 counterparty_delayed_payment_base_key.write(writer)?;
372                                 counterparty_htlc_base_key.write(writer)?;
373                                 preimage.write(writer)?;
374                                 htlc.write(writer)?;
375                         },
376                         &InputMaterial::HolderHTLC { ref preimage, ref amount } => {
377                                 writer.write_all(&[2; 1])?;
378                                 preimage.write(writer)?;
379                                 writer.write_all(&byte_utils::be64_to_array(*amount))?;
380                         },
381                         &InputMaterial::Funding { ref funding_redeemscript } => {
382                                 writer.write_all(&[3; 1])?;
383                                 funding_redeemscript.write(writer)?;
384                         }
385                 }
386                 Ok(())
387         }
388 }
389
390 impl Readable for InputMaterial {
391         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
392                 let input_material = match <u8 as Readable>::read(reader)? {
393                         0 => {
394                                 let per_commitment_point = Readable::read(reader)?;
395                                 let counterparty_delayed_payment_base_key = Readable::read(reader)?;
396                                 let counterparty_htlc_base_key = Readable::read(reader)?;
397                                 let per_commitment_key = Readable::read(reader)?;
398                                 let input_descriptor = Readable::read(reader)?;
399                                 let amount = Readable::read(reader)?;
400                                 let htlc = Readable::read(reader)?;
401                                 let on_counterparty_tx_csv = Readable::read(reader)?;
402                                 InputMaterial::Revoked {
403                                         per_commitment_point,
404                                         counterparty_delayed_payment_base_key,
405                                         counterparty_htlc_base_key,
406                                         per_commitment_key,
407                                         input_descriptor,
408                                         amount,
409                                         htlc,
410                                         on_counterparty_tx_csv
411                                 }
412                         },
413                         1 => {
414                                 let per_commitment_point = Readable::read(reader)?;
415                                 let counterparty_delayed_payment_base_key = Readable::read(reader)?;
416                                 let counterparty_htlc_base_key = Readable::read(reader)?;
417                                 let preimage = Readable::read(reader)?;
418                                 let htlc = Readable::read(reader)?;
419                                 InputMaterial::CounterpartyHTLC {
420                                         per_commitment_point,
421                                         counterparty_delayed_payment_base_key,
422                                         counterparty_htlc_base_key,
423                                         preimage,
424                                         htlc
425                                 }
426                         },
427                         2 => {
428                                 let preimage = Readable::read(reader)?;
429                                 let amount = Readable::read(reader)?;
430                                 InputMaterial::HolderHTLC {
431                                         preimage,
432                                         amount,
433                                 }
434                         },
435                         3 => {
436                                 InputMaterial::Funding {
437                                         funding_redeemscript: Readable::read(reader)?,
438                                 }
439                         }
440                         _ => return Err(DecodeError::InvalidValue),
441                 };
442                 Ok(input_material)
443         }
444 }
445
446 /// ClaimRequest is a descriptor structure to communicate between detection
447 /// and reaction module. They are generated by ChannelMonitor while parsing
448 /// onchain txn leaked from a channel and handed over to OnchainTxHandler which
449 /// is responsible for opportunistic aggregation, selecting and enforcing
450 /// bumping logic, building and signing transactions.
451 pub(crate) struct ClaimRequest {
452         // Block height before which claiming is exclusive to one party,
453         // after reaching it, claiming may be contentious.
454         pub(crate) absolute_timelock: u32,
455         // Timeout tx must have nLocktime set which means aggregating multiple
456         // ones must take the higher nLocktime among them to satisfy all of them.
457         // Sadly it has few pitfalls, a) it takes longuer to get fund back b) CLTV_DELTA
458         // of a sooner-HTLC could be swallowed by the highest nLocktime of the HTLC set.
459         // Do simplify we mark them as non-aggregable.
460         pub(crate) aggregable: bool,
461         // Basic bitcoin outpoint (txid, vout)
462         pub(crate) outpoint: BitcoinOutPoint,
463         // Following outpoint type, set of data needed to generate transaction digest
464         // and satisfy witness program.
465         pub(crate) witness_data: InputMaterial
466 }
467
468 /// An entry for an [`OnchainEvent`], stating the block height when the event was observed and the
469 /// transaction causing it.
470 ///
471 /// Used to determine when the on-chain event can be considered safe from a chain reorganization.
472 #[derive(PartialEq)]
473 struct OnchainEventEntry {
474         txid: Txid,
475         height: u32,
476         event: OnchainEvent,
477 }
478
479 impl OnchainEventEntry {
480         fn confirmation_threshold(&self) -> u32 {
481                 self.height + ANTI_REORG_DELAY - 1
482         }
483
484         fn has_reached_confirmation_threshold(&self, height: u32) -> bool {
485                 height >= self.confirmation_threshold()
486         }
487 }
488
489 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
490 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
491 #[derive(PartialEq)]
492 enum OnchainEvent {
493         /// HTLC output getting solved by a timeout, at maturation we pass upstream payment source information to solve
494         /// inbound HTLC in backward channel. Note, in case of preimage, we pass info to upstream without delay as we can
495         /// only win from it, so it's never an OnchainEvent
496         HTLCUpdate {
497                 htlc_update: (HTLCSource, PaymentHash),
498         },
499         MaturingOutput {
500                 descriptor: SpendableOutputDescriptor,
501         },
502 }
503
504 const SERIALIZATION_VERSION: u8 = 1;
505 const MIN_SERIALIZATION_VERSION: u8 = 1;
506
507 #[cfg_attr(any(test, feature = "fuzztarget", feature = "_test_utils"), derive(PartialEq))]
508 #[derive(Clone)]
509 pub(crate) enum ChannelMonitorUpdateStep {
510         LatestHolderCommitmentTXInfo {
511                 commitment_tx: HolderCommitmentTransaction,
512                 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
513         },
514         LatestCounterpartyCommitmentTXInfo {
515                 commitment_txid: Txid,
516                 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
517                 commitment_number: u64,
518                 their_revocation_point: PublicKey,
519         },
520         PaymentPreimage {
521                 payment_preimage: PaymentPreimage,
522         },
523         CommitmentSecret {
524                 idx: u64,
525                 secret: [u8; 32],
526         },
527         /// Used to indicate that the no future updates will occur, and likely that the latest holder
528         /// commitment transaction(s) should be broadcast, as the channel has been force-closed.
529         ChannelForceClosed {
530                 /// If set to false, we shouldn't broadcast the latest holder commitment transaction as we
531                 /// think we've fallen behind!
532                 should_broadcast: bool,
533         },
534 }
535
536 impl Writeable for ChannelMonitorUpdateStep {
537         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
538                 match self {
539                         &ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { ref commitment_tx, ref htlc_outputs } => {
540                                 0u8.write(w)?;
541                                 commitment_tx.write(w)?;
542                                 (htlc_outputs.len() as u64).write(w)?;
543                                 for &(ref output, ref signature, ref source) in htlc_outputs.iter() {
544                                         output.write(w)?;
545                                         signature.write(w)?;
546                                         source.write(w)?;
547                                 }
548                         }
549                         &ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid, ref htlc_outputs, ref commitment_number, ref their_revocation_point } => {
550                                 1u8.write(w)?;
551                                 commitment_txid.write(w)?;
552                                 commitment_number.write(w)?;
553                                 their_revocation_point.write(w)?;
554                                 (htlc_outputs.len() as u64).write(w)?;
555                                 for &(ref output, ref source) in htlc_outputs.iter() {
556                                         output.write(w)?;
557                                         source.as_ref().map(|b| b.as_ref()).write(w)?;
558                                 }
559                         },
560                         &ChannelMonitorUpdateStep::PaymentPreimage { ref payment_preimage } => {
561                                 2u8.write(w)?;
562                                 payment_preimage.write(w)?;
563                         },
564                         &ChannelMonitorUpdateStep::CommitmentSecret { ref idx, ref secret } => {
565                                 3u8.write(w)?;
566                                 idx.write(w)?;
567                                 secret.write(w)?;
568                         },
569                         &ChannelMonitorUpdateStep::ChannelForceClosed { ref should_broadcast } => {
570                                 4u8.write(w)?;
571                                 should_broadcast.write(w)?;
572                         },
573                 }
574                 Ok(())
575         }
576 }
577 impl Readable for ChannelMonitorUpdateStep {
578         fn read<R: ::std::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
579                 match Readable::read(r)? {
580                         0u8 => {
581                                 Ok(ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
582                                         commitment_tx: Readable::read(r)?,
583                                         htlc_outputs: {
584                                                 let len: u64 = Readable::read(r)?;
585                                                 let mut res = Vec::new();
586                                                 for _ in 0..len {
587                                                         res.push((Readable::read(r)?, Readable::read(r)?, Readable::read(r)?));
588                                                 }
589                                                 res
590                                         },
591                                 })
592                         },
593                         1u8 => {
594                                 Ok(ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
595                                         commitment_txid: Readable::read(r)?,
596                                         commitment_number: Readable::read(r)?,
597                                         their_revocation_point: Readable::read(r)?,
598                                         htlc_outputs: {
599                                                 let len: u64 = Readable::read(r)?;
600                                                 let mut res = Vec::new();
601                                                 for _ in 0..len {
602                                                         res.push((Readable::read(r)?, <Option<HTLCSource> as Readable>::read(r)?.map(|o| Box::new(o))));
603                                                 }
604                                                 res
605                                         },
606                                 })
607                         },
608                         2u8 => {
609                                 Ok(ChannelMonitorUpdateStep::PaymentPreimage {
610                                         payment_preimage: Readable::read(r)?,
611                                 })
612                         },
613                         3u8 => {
614                                 Ok(ChannelMonitorUpdateStep::CommitmentSecret {
615                                         idx: Readable::read(r)?,
616                                         secret: Readable::read(r)?,
617                                 })
618                         },
619                         4u8 => {
620                                 Ok(ChannelMonitorUpdateStep::ChannelForceClosed {
621                                         should_broadcast: Readable::read(r)?
622                                 })
623                         },
624                         _ => Err(DecodeError::InvalidValue),
625                 }
626         }
627 }
628
629 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
630 /// on-chain transactions to ensure no loss of funds occurs.
631 ///
632 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
633 /// information and are actively monitoring the chain.
634 ///
635 /// Pending Events or updated HTLCs which have not yet been read out by
636 /// get_and_clear_pending_monitor_events or get_and_clear_pending_events are serialized to disk and
637 /// reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
638 /// gotten are fully handled before re-serializing the new state.
639 ///
640 /// Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
641 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
642 /// the "reorg path" (ie disconnecting blocks until you find a common ancestor from both the
643 /// returned block hash and the the current chain and then reconnecting blocks to get to the
644 /// best chain) upon deserializing the object!
645 pub struct ChannelMonitor<Signer: Sign> {
646         #[cfg(test)]
647         pub(crate) inner: Mutex<ChannelMonitorImpl<Signer>>,
648         #[cfg(not(test))]
649         inner: Mutex<ChannelMonitorImpl<Signer>>,
650 }
651
652 pub(crate) struct ChannelMonitorImpl<Signer: Sign> {
653         latest_update_id: u64,
654         commitment_transaction_number_obscure_factor: u64,
655
656         destination_script: Script,
657         broadcasted_holder_revokable_script: Option<(Script, PublicKey, PublicKey)>,
658         counterparty_payment_script: Script,
659         shutdown_script: Script,
660
661         channel_keys_id: [u8; 32],
662         holder_revocation_basepoint: PublicKey,
663         funding_info: (OutPoint, Script),
664         current_counterparty_commitment_txid: Option<Txid>,
665         prev_counterparty_commitment_txid: Option<Txid>,
666
667         counterparty_tx_cache: CounterpartyCommitmentTransaction,
668         funding_redeemscript: Script,
669         channel_value_satoshis: u64,
670         // first is the idx of the first of the two revocation points
671         their_cur_revocation_points: Option<(u64, PublicKey, Option<PublicKey>)>,
672
673         on_holder_tx_csv: u16,
674
675         commitment_secrets: CounterpartyCommitmentSecrets,
676         counterparty_claimable_outpoints: HashMap<Txid, Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>>,
677         /// We cannot identify HTLC-Success or HTLC-Timeout transactions by themselves on the chain.
678         /// Nor can we figure out their commitment numbers without the commitment transaction they are
679         /// spending. Thus, in order to claim them via revocation key, we track all the counterparty
680         /// commitment transactions which we find on-chain, mapping them to the commitment number which
681         /// can be used to derive the revocation key and claim the transactions.
682         counterparty_commitment_txn_on_chain: HashMap<Txid, u64>,
683         /// Cache used to make pruning of payment_preimages faster.
684         /// Maps payment_hash values to commitment numbers for counterparty transactions for non-revoked
685         /// counterparty transactions (ie should remain pretty small).
686         /// Serialized to disk but should generally not be sent to Watchtowers.
687         counterparty_hash_commitment_number: HashMap<PaymentHash, u64>,
688
689         // We store two holder commitment transactions to avoid any race conditions where we may update
690         // some monitors (potentially on watchtowers) but then fail to update others, resulting in the
691         // various monitors for one channel being out of sync, and us broadcasting a holder
692         // transaction for which we have deleted claim information on some watchtowers.
693         prev_holder_signed_commitment_tx: Option<HolderSignedTx>,
694         current_holder_commitment_tx: HolderSignedTx,
695
696         // Used just for ChannelManager to make sure it has the latest channel data during
697         // deserialization
698         current_counterparty_commitment_number: u64,
699         // Used just for ChannelManager to make sure it has the latest channel data during
700         // deserialization
701         current_holder_commitment_number: u64,
702
703         payment_preimages: HashMap<PaymentHash, PaymentPreimage>,
704
705         pending_monitor_events: Vec<MonitorEvent>,
706         pending_events: Vec<Event>,
707
708         // Used to track on-chain events (i.e., transactions part of channels confirmed on chain) on
709         // which to take actions once they reach enough confirmations. Each entry includes the
710         // transaction's id and the height when the transaction was confirmed on chain.
711         onchain_events_awaiting_threshold_conf: Vec<OnchainEventEntry>,
712
713         // If we get serialized out and re-read, we need to make sure that the chain monitoring
714         // interface knows about the TXOs that we want to be notified of spends of. We could probably
715         // be smart and derive them from the above storage fields, but its much simpler and more
716         // Obviously Correct (tm) if we just keep track of them explicitly.
717         outputs_to_watch: HashMap<Txid, Vec<(u32, Script)>>,
718
719         #[cfg(test)]
720         pub onchain_tx_handler: OnchainTxHandler<Signer>,
721         #[cfg(not(test))]
722         onchain_tx_handler: OnchainTxHandler<Signer>,
723
724         // This is set when the Channel[Manager] generated a ChannelMonitorUpdate which indicated the
725         // channel has been force-closed. After this is set, no further holder commitment transaction
726         // updates may occur, and we panic!() if one is provided.
727         lockdown_from_offchain: bool,
728
729         // Set once we've signed a holder commitment transaction and handed it over to our
730         // OnchainTxHandler. After this is set, no future updates to our holder commitment transactions
731         // may occur, and we fail any such monitor updates.
732         //
733         // In case of update rejection due to a locally already signed commitment transaction, we
734         // nevertheless store update content to track in case of concurrent broadcast by another
735         // remote monitor out-of-order with regards to the block view.
736         holder_tx_signed: bool,
737
738         // We simply modify best_block in Channel's block_connected so that serialization is
739         // consistent but hopefully the users' copy handles block_connected in a consistent way.
740         // (we do *not*, however, update them in update_monitor to ensure any local user copies keep
741         // their best_block from its state and not based on updated copies that didn't run through
742         // the full block_connected).
743         best_block: BestBlock,
744
745         secp_ctx: Secp256k1<secp256k1::All>, //TODO: dedup this a bit...
746 }
747
748 /// Transaction outputs to watch for on-chain spends.
749 pub(super) type TransactionOutputs = (Txid, Vec<(u32, TxOut)>);
750
751 #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
752 /// Used only in testing and fuzztarget to check serialization roundtrips don't change the
753 /// underlying object
754 impl<Signer: Sign> PartialEq for ChannelMonitor<Signer> {
755         fn eq(&self, other: &Self) -> bool {
756                 let inner = self.inner.lock().unwrap();
757                 let other = other.inner.lock().unwrap();
758                 inner.eq(&other)
759         }
760 }
761
762 #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
763 /// Used only in testing and fuzztarget to check serialization roundtrips don't change the
764 /// underlying object
765 impl<Signer: Sign> PartialEq for ChannelMonitorImpl<Signer> {
766         fn eq(&self, other: &Self) -> bool {
767                 if self.latest_update_id != other.latest_update_id ||
768                         self.commitment_transaction_number_obscure_factor != other.commitment_transaction_number_obscure_factor ||
769                         self.destination_script != other.destination_script ||
770                         self.broadcasted_holder_revokable_script != other.broadcasted_holder_revokable_script ||
771                         self.counterparty_payment_script != other.counterparty_payment_script ||
772                         self.channel_keys_id != other.channel_keys_id ||
773                         self.holder_revocation_basepoint != other.holder_revocation_basepoint ||
774                         self.funding_info != other.funding_info ||
775                         self.current_counterparty_commitment_txid != other.current_counterparty_commitment_txid ||
776                         self.prev_counterparty_commitment_txid != other.prev_counterparty_commitment_txid ||
777                         self.counterparty_tx_cache != other.counterparty_tx_cache ||
778                         self.funding_redeemscript != other.funding_redeemscript ||
779                         self.channel_value_satoshis != other.channel_value_satoshis ||
780                         self.their_cur_revocation_points != other.their_cur_revocation_points ||
781                         self.on_holder_tx_csv != other.on_holder_tx_csv ||
782                         self.commitment_secrets != other.commitment_secrets ||
783                         self.counterparty_claimable_outpoints != other.counterparty_claimable_outpoints ||
784                         self.counterparty_commitment_txn_on_chain != other.counterparty_commitment_txn_on_chain ||
785                         self.counterparty_hash_commitment_number != other.counterparty_hash_commitment_number ||
786                         self.prev_holder_signed_commitment_tx != other.prev_holder_signed_commitment_tx ||
787                         self.current_counterparty_commitment_number != other.current_counterparty_commitment_number ||
788                         self.current_holder_commitment_number != other.current_holder_commitment_number ||
789                         self.current_holder_commitment_tx != other.current_holder_commitment_tx ||
790                         self.payment_preimages != other.payment_preimages ||
791                         self.pending_monitor_events != other.pending_monitor_events ||
792                         self.pending_events.len() != other.pending_events.len() || // We trust events to round-trip properly
793                         self.onchain_events_awaiting_threshold_conf != other.onchain_events_awaiting_threshold_conf ||
794                         self.outputs_to_watch != other.outputs_to_watch ||
795                         self.lockdown_from_offchain != other.lockdown_from_offchain ||
796                         self.holder_tx_signed != other.holder_tx_signed
797                 {
798                         false
799                 } else {
800                         true
801                 }
802         }
803 }
804
805 impl<Signer: Sign> Writeable for ChannelMonitor<Signer> {
806         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
807                 //TODO: We still write out all the serialization here manually instead of using the fancy
808                 //serialization framework we have, we should migrate things over to it.
809                 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
810                 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
811
812                 self.inner.lock().unwrap().write(writer)
813         }
814 }
815
816 impl<Signer: Sign> Writeable for ChannelMonitorImpl<Signer> {
817         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
818                 self.latest_update_id.write(writer)?;
819
820                 // Set in initial Channel-object creation, so should always be set by now:
821                 U48(self.commitment_transaction_number_obscure_factor).write(writer)?;
822
823                 self.destination_script.write(writer)?;
824                 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
825                         writer.write_all(&[0; 1])?;
826                         broadcasted_holder_revokable_script.0.write(writer)?;
827                         broadcasted_holder_revokable_script.1.write(writer)?;
828                         broadcasted_holder_revokable_script.2.write(writer)?;
829                 } else {
830                         writer.write_all(&[1; 1])?;
831                 }
832
833                 self.counterparty_payment_script.write(writer)?;
834                 self.shutdown_script.write(writer)?;
835
836                 self.channel_keys_id.write(writer)?;
837                 self.holder_revocation_basepoint.write(writer)?;
838                 writer.write_all(&self.funding_info.0.txid[..])?;
839                 writer.write_all(&byte_utils::be16_to_array(self.funding_info.0.index))?;
840                 self.funding_info.1.write(writer)?;
841                 self.current_counterparty_commitment_txid.write(writer)?;
842                 self.prev_counterparty_commitment_txid.write(writer)?;
843
844                 self.counterparty_tx_cache.write(writer)?;
845                 self.funding_redeemscript.write(writer)?;
846                 self.channel_value_satoshis.write(writer)?;
847
848                 match self.their_cur_revocation_points {
849                         Some((idx, pubkey, second_option)) => {
850                                 writer.write_all(&byte_utils::be48_to_array(idx))?;
851                                 writer.write_all(&pubkey.serialize())?;
852                                 match second_option {
853                                         Some(second_pubkey) => {
854                                                 writer.write_all(&second_pubkey.serialize())?;
855                                         },
856                                         None => {
857                                                 writer.write_all(&[0; 33])?;
858                                         },
859                                 }
860                         },
861                         None => {
862                                 writer.write_all(&byte_utils::be48_to_array(0))?;
863                         },
864                 }
865
866                 writer.write_all(&byte_utils::be16_to_array(self.on_holder_tx_csv))?;
867
868                 self.commitment_secrets.write(writer)?;
869
870                 macro_rules! serialize_htlc_in_commitment {
871                         ($htlc_output: expr) => {
872                                 writer.write_all(&[$htlc_output.offered as u8; 1])?;
873                                 writer.write_all(&byte_utils::be64_to_array($htlc_output.amount_msat))?;
874                                 writer.write_all(&byte_utils::be32_to_array($htlc_output.cltv_expiry))?;
875                                 writer.write_all(&$htlc_output.payment_hash.0[..])?;
876                                 $htlc_output.transaction_output_index.write(writer)?;
877                         }
878                 }
879
880                 writer.write_all(&byte_utils::be64_to_array(self.counterparty_claimable_outpoints.len() as u64))?;
881                 for (ref txid, ref htlc_infos) in self.counterparty_claimable_outpoints.iter() {
882                         writer.write_all(&txid[..])?;
883                         writer.write_all(&byte_utils::be64_to_array(htlc_infos.len() as u64))?;
884                         for &(ref htlc_output, ref htlc_source) in htlc_infos.iter() {
885                                 serialize_htlc_in_commitment!(htlc_output);
886                                 htlc_source.as_ref().map(|b| b.as_ref()).write(writer)?;
887                         }
888                 }
889
890                 writer.write_all(&byte_utils::be64_to_array(self.counterparty_commitment_txn_on_chain.len() as u64))?;
891                 for (ref txid, commitment_number) in self.counterparty_commitment_txn_on_chain.iter() {
892                         writer.write_all(&txid[..])?;
893                         writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
894                 }
895
896                 writer.write_all(&byte_utils::be64_to_array(self.counterparty_hash_commitment_number.len() as u64))?;
897                 for (ref payment_hash, commitment_number) in self.counterparty_hash_commitment_number.iter() {
898                         writer.write_all(&payment_hash.0[..])?;
899                         writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
900                 }
901
902                 macro_rules! serialize_holder_tx {
903                         ($holder_tx: expr) => {
904                                 $holder_tx.txid.write(writer)?;
905                                 writer.write_all(&$holder_tx.revocation_key.serialize())?;
906                                 writer.write_all(&$holder_tx.a_htlc_key.serialize())?;
907                                 writer.write_all(&$holder_tx.b_htlc_key.serialize())?;
908                                 writer.write_all(&$holder_tx.delayed_payment_key.serialize())?;
909                                 writer.write_all(&$holder_tx.per_commitment_point.serialize())?;
910
911                                 writer.write_all(&byte_utils::be32_to_array($holder_tx.feerate_per_kw))?;
912                                 writer.write_all(&byte_utils::be64_to_array($holder_tx.htlc_outputs.len() as u64))?;
913                                 for &(ref htlc_output, ref sig, ref htlc_source) in $holder_tx.htlc_outputs.iter() {
914                                         serialize_htlc_in_commitment!(htlc_output);
915                                         if let &Some(ref their_sig) = sig {
916                                                 1u8.write(writer)?;
917                                                 writer.write_all(&their_sig.serialize_compact())?;
918                                         } else {
919                                                 0u8.write(writer)?;
920                                         }
921                                         htlc_source.write(writer)?;
922                                 }
923                         }
924                 }
925
926                 if let Some(ref prev_holder_tx) = self.prev_holder_signed_commitment_tx {
927                         writer.write_all(&[1; 1])?;
928                         serialize_holder_tx!(prev_holder_tx);
929                 } else {
930                         writer.write_all(&[0; 1])?;
931                 }
932
933                 serialize_holder_tx!(self.current_holder_commitment_tx);
934
935                 writer.write_all(&byte_utils::be48_to_array(self.current_counterparty_commitment_number))?;
936                 writer.write_all(&byte_utils::be48_to_array(self.current_holder_commitment_number))?;
937
938                 writer.write_all(&byte_utils::be64_to_array(self.payment_preimages.len() as u64))?;
939                 for payment_preimage in self.payment_preimages.values() {
940                         writer.write_all(&payment_preimage.0[..])?;
941                 }
942
943                 writer.write_all(&byte_utils::be64_to_array(self.pending_monitor_events.len() as u64))?;
944                 for event in self.pending_monitor_events.iter() {
945                         match event {
946                                 MonitorEvent::HTLCEvent(upd) => {
947                                         0u8.write(writer)?;
948                                         upd.write(writer)?;
949                                 },
950                                 MonitorEvent::CommitmentTxBroadcasted(_) => 1u8.write(writer)?
951                         }
952                 }
953
954                 writer.write_all(&byte_utils::be64_to_array(self.pending_events.len() as u64))?;
955                 for event in self.pending_events.iter() {
956                         event.write(writer)?;
957                 }
958
959                 self.best_block.block_hash().write(writer)?;
960                 writer.write_all(&byte_utils::be32_to_array(self.best_block.height()))?;
961
962                 writer.write_all(&byte_utils::be64_to_array(self.onchain_events_awaiting_threshold_conf.len() as u64))?;
963                 for ref entry in self.onchain_events_awaiting_threshold_conf.iter() {
964                         entry.txid.write(writer)?;
965                         writer.write_all(&byte_utils::be32_to_array(entry.height))?;
966                         match entry.event {
967                                 OnchainEvent::HTLCUpdate { ref htlc_update } => {
968                                         0u8.write(writer)?;
969                                         htlc_update.0.write(writer)?;
970                                         htlc_update.1.write(writer)?;
971                                 },
972                                 OnchainEvent::MaturingOutput { ref descriptor } => {
973                                         1u8.write(writer)?;
974                                         descriptor.write(writer)?;
975                                 },
976                         }
977                 }
978
979                 (self.outputs_to_watch.len() as u64).write(writer)?;
980                 for (txid, idx_scripts) in self.outputs_to_watch.iter() {
981                         txid.write(writer)?;
982                         (idx_scripts.len() as u64).write(writer)?;
983                         for (idx, script) in idx_scripts.iter() {
984                                 idx.write(writer)?;
985                                 script.write(writer)?;
986                         }
987                 }
988                 self.onchain_tx_handler.write(writer)?;
989
990                 self.lockdown_from_offchain.write(writer)?;
991                 self.holder_tx_signed.write(writer)?;
992
993                 Ok(())
994         }
995 }
996
997 impl<Signer: Sign> ChannelMonitor<Signer> {
998         pub(crate) fn new(secp_ctx: Secp256k1<secp256k1::All>, keys: Signer, shutdown_pubkey: &PublicKey,
999                           on_counterparty_tx_csv: u16, destination_script: &Script, funding_info: (OutPoint, Script),
1000                           channel_parameters: &ChannelTransactionParameters,
1001                           funding_redeemscript: Script, channel_value_satoshis: u64,
1002                           commitment_transaction_number_obscure_factor: u64,
1003                           initial_holder_commitment_tx: HolderCommitmentTransaction,
1004                           best_block: BestBlock) -> ChannelMonitor<Signer> {
1005
1006                 assert!(commitment_transaction_number_obscure_factor <= (1 << 48));
1007                 let our_channel_close_key_hash = WPubkeyHash::hash(&shutdown_pubkey.serialize());
1008                 let shutdown_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script();
1009                 let payment_key_hash = WPubkeyHash::hash(&keys.pubkeys().payment_point.serialize());
1010                 let counterparty_payment_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&payment_key_hash[..]).into_script();
1011
1012                 let counterparty_channel_parameters = channel_parameters.counterparty_parameters.as_ref().unwrap();
1013                 let counterparty_delayed_payment_base_key = counterparty_channel_parameters.pubkeys.delayed_payment_basepoint;
1014                 let counterparty_htlc_base_key = counterparty_channel_parameters.pubkeys.htlc_basepoint;
1015                 let counterparty_tx_cache = CounterpartyCommitmentTransaction { counterparty_delayed_payment_base_key, counterparty_htlc_base_key, on_counterparty_tx_csv, per_htlc: HashMap::new() };
1016
1017                 let channel_keys_id = keys.channel_keys_id();
1018                 let holder_revocation_basepoint = keys.pubkeys().revocation_basepoint;
1019
1020                 // block for Rust 1.34 compat
1021                 let (holder_commitment_tx, current_holder_commitment_number) = {
1022                         let trusted_tx = initial_holder_commitment_tx.trust();
1023                         let txid = trusted_tx.txid();
1024
1025                         let tx_keys = trusted_tx.keys();
1026                         let holder_commitment_tx = HolderSignedTx {
1027                                 txid,
1028                                 revocation_key: tx_keys.revocation_key,
1029                                 a_htlc_key: tx_keys.broadcaster_htlc_key,
1030                                 b_htlc_key: tx_keys.countersignatory_htlc_key,
1031                                 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
1032                                 per_commitment_point: tx_keys.per_commitment_point,
1033                                 feerate_per_kw: trusted_tx.feerate_per_kw(),
1034                                 htlc_outputs: Vec::new(), // There are never any HTLCs in the initial commitment transactions
1035                         };
1036                         (holder_commitment_tx, trusted_tx.commitment_number())
1037                 };
1038
1039                 let onchain_tx_handler =
1040                         OnchainTxHandler::new(destination_script.clone(), keys,
1041                         channel_parameters.clone(), initial_holder_commitment_tx, secp_ctx.clone());
1042
1043                 let mut outputs_to_watch = HashMap::new();
1044                 outputs_to_watch.insert(funding_info.0.txid, vec![(funding_info.0.index as u32, funding_info.1.clone())]);
1045
1046                 ChannelMonitor {
1047                         inner: Mutex::new(ChannelMonitorImpl {
1048                                 latest_update_id: 0,
1049                                 commitment_transaction_number_obscure_factor,
1050
1051                                 destination_script: destination_script.clone(),
1052                                 broadcasted_holder_revokable_script: None,
1053                                 counterparty_payment_script,
1054                                 shutdown_script,
1055
1056                                 channel_keys_id,
1057                                 holder_revocation_basepoint,
1058                                 funding_info,
1059                                 current_counterparty_commitment_txid: None,
1060                                 prev_counterparty_commitment_txid: None,
1061
1062                                 counterparty_tx_cache,
1063                                 funding_redeemscript,
1064                                 channel_value_satoshis,
1065                                 their_cur_revocation_points: None,
1066
1067                                 on_holder_tx_csv: counterparty_channel_parameters.selected_contest_delay,
1068
1069                                 commitment_secrets: CounterpartyCommitmentSecrets::new(),
1070                                 counterparty_claimable_outpoints: HashMap::new(),
1071                                 counterparty_commitment_txn_on_chain: HashMap::new(),
1072                                 counterparty_hash_commitment_number: HashMap::new(),
1073
1074                                 prev_holder_signed_commitment_tx: None,
1075                                 current_holder_commitment_tx: holder_commitment_tx,
1076                                 current_counterparty_commitment_number: 1 << 48,
1077                                 current_holder_commitment_number,
1078
1079                                 payment_preimages: HashMap::new(),
1080                                 pending_monitor_events: Vec::new(),
1081                                 pending_events: Vec::new(),
1082
1083                                 onchain_events_awaiting_threshold_conf: Vec::new(),
1084                                 outputs_to_watch,
1085
1086                                 onchain_tx_handler,
1087
1088                                 lockdown_from_offchain: false,
1089                                 holder_tx_signed: false,
1090
1091                                 best_block,
1092
1093                                 secp_ctx,
1094                         }),
1095                 }
1096         }
1097
1098         #[cfg(test)]
1099         fn provide_secret(&self, idx: u64, secret: [u8; 32]) -> Result<(), MonitorUpdateError> {
1100                 self.inner.lock().unwrap().provide_secret(idx, secret)
1101         }
1102
1103         /// Informs this monitor of the latest counterparty (ie non-broadcastable) commitment transaction.
1104         /// The monitor watches for it to be broadcasted and then uses the HTLC information (and
1105         /// possibly future revocation/preimage information) to claim outputs where possible.
1106         /// We cache also the mapping hash:commitment number to lighten pruning of old preimages by watchtowers.
1107         pub(crate) fn provide_latest_counterparty_commitment_tx<L: Deref>(
1108                 &self,
1109                 txid: Txid,
1110                 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
1111                 commitment_number: u64,
1112                 their_revocation_point: PublicKey,
1113                 logger: &L,
1114         ) where L::Target: Logger {
1115                 self.inner.lock().unwrap().provide_latest_counterparty_commitment_tx(
1116                         txid, htlc_outputs, commitment_number, their_revocation_point, logger)
1117         }
1118
1119         #[cfg(test)]
1120         fn provide_latest_holder_commitment_tx(
1121                 &self,
1122                 holder_commitment_tx: HolderCommitmentTransaction,
1123                 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
1124         ) -> Result<(), MonitorUpdateError> {
1125                 self.inner.lock().unwrap().provide_latest_holder_commitment_tx(
1126                         holder_commitment_tx, htlc_outputs)
1127         }
1128
1129         #[cfg(test)]
1130         pub(crate) fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
1131                 &self,
1132                 payment_hash: &PaymentHash,
1133                 payment_preimage: &PaymentPreimage,
1134                 broadcaster: &B,
1135                 fee_estimator: &F,
1136                 logger: &L,
1137         ) where
1138                 B::Target: BroadcasterInterface,
1139                 F::Target: FeeEstimator,
1140                 L::Target: Logger,
1141         {
1142                 self.inner.lock().unwrap().provide_payment_preimage(
1143                         payment_hash, payment_preimage, broadcaster, fee_estimator, logger)
1144         }
1145
1146         pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(
1147                 &self,
1148                 broadcaster: &B,
1149                 logger: &L,
1150         ) where
1151                 B::Target: BroadcasterInterface,
1152                 L::Target: Logger,
1153         {
1154                 self.inner.lock().unwrap().broadcast_latest_holder_commitment_txn(broadcaster, logger)
1155         }
1156
1157         /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
1158         /// itself.
1159         ///
1160         /// panics if the given update is not the next update by update_id.
1161         pub fn update_monitor<B: Deref, F: Deref, L: Deref>(
1162                 &self,
1163                 updates: &ChannelMonitorUpdate,
1164                 broadcaster: &B,
1165                 fee_estimator: &F,
1166                 logger: &L,
1167         ) -> Result<(), MonitorUpdateError>
1168         where
1169                 B::Target: BroadcasterInterface,
1170                 F::Target: FeeEstimator,
1171                 L::Target: Logger,
1172         {
1173                 self.inner.lock().unwrap().update_monitor(updates, broadcaster, fee_estimator, logger)
1174         }
1175
1176         /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
1177         /// ChannelMonitor.
1178         pub fn get_latest_update_id(&self) -> u64 {
1179                 self.inner.lock().unwrap().get_latest_update_id()
1180         }
1181
1182         /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
1183         pub fn get_funding_txo(&self) -> (OutPoint, Script) {
1184                 self.inner.lock().unwrap().get_funding_txo().clone()
1185         }
1186
1187         /// Gets a list of txids, with their output scripts (in the order they appear in the
1188         /// transaction), which we must learn about spends of via block_connected().
1189         pub fn get_outputs_to_watch(&self) -> Vec<(Txid, Vec<(u32, Script)>)> {
1190                 self.inner.lock().unwrap().get_outputs_to_watch()
1191                         .iter().map(|(txid, outputs)| (*txid, outputs.clone())).collect()
1192         }
1193
1194         /// Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
1195         /// calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
1196         /// have been registered.
1197         pub fn load_outputs_to_watch<F: Deref>(&self, filter: &F) where F::Target: chain::Filter {
1198                 let lock = self.inner.lock().unwrap();
1199                 filter.register_tx(&lock.get_funding_txo().0.txid, &lock.get_funding_txo().1);
1200                 for (txid, outputs) in lock.get_outputs_to_watch().iter() {
1201                         for (index, script_pubkey) in outputs.iter() {
1202                                 assert!(*index <= u16::max_value() as u32);
1203                                 filter.register_output(WatchedOutput {
1204                                         block_hash: None,
1205                                         outpoint: OutPoint { txid: *txid, index: *index as u16 },
1206                                         script_pubkey: script_pubkey.clone(),
1207                                 });
1208                         }
1209                 }
1210         }
1211
1212         /// Get the list of HTLCs who's status has been updated on chain. This should be called by
1213         /// ChannelManager via [`chain::Watch::release_pending_monitor_events`].
1214         pub fn get_and_clear_pending_monitor_events(&self) -> Vec<MonitorEvent> {
1215                 self.inner.lock().unwrap().get_and_clear_pending_monitor_events()
1216         }
1217
1218         /// Gets the list of pending events which were generated by previous actions, clearing the list
1219         /// in the process.
1220         ///
1221         /// This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
1222         /// EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
1223         /// no internal locking in ChannelMonitors.
1224         pub fn get_and_clear_pending_events(&self) -> Vec<Event> {
1225                 self.inner.lock().unwrap().get_and_clear_pending_events()
1226         }
1227
1228         pub(crate) fn get_min_seen_secret(&self) -> u64 {
1229                 self.inner.lock().unwrap().get_min_seen_secret()
1230         }
1231
1232         pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
1233                 self.inner.lock().unwrap().get_cur_counterparty_commitment_number()
1234         }
1235
1236         pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
1237                 self.inner.lock().unwrap().get_cur_holder_commitment_number()
1238         }
1239
1240         /// Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
1241         /// the Channel was out-of-date. You may use it to get a broadcastable holder toxic tx in case of
1242         /// fallen-behind, i.e when receiving a channel_reestablish with a proof that our counterparty side knows
1243         /// a higher revocation secret than the holder commitment number we are aware of. Broadcasting these
1244         /// transactions are UNSAFE, as they allow counterparty side to punish you. Nevertheless you may want to
1245         /// broadcast them if counterparty don't close channel with his higher commitment transaction after a
1246         /// substantial amount of time (a month or even a year) to get back funds. Best may be to contact
1247         /// out-of-band the other node operator to coordinate with him if option is available to you.
1248         /// In any-case, choice is up to the user.
1249         pub fn get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1250         where L::Target: Logger {
1251                 self.inner.lock().unwrap().get_latest_holder_commitment_txn(logger)
1252         }
1253
1254         /// Unsafe test-only version of get_latest_holder_commitment_txn used by our test framework
1255         /// to bypass HolderCommitmentTransaction state update lockdown after signature and generate
1256         /// revoked commitment transaction.
1257         #[cfg(any(test, feature = "unsafe_revoked_tx_signing"))]
1258         pub fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1259         where L::Target: Logger {
1260                 self.inner.lock().unwrap().unsafe_get_latest_holder_commitment_txn(logger)
1261         }
1262
1263         /// Processes transactions in a newly connected block, which may result in any of the following:
1264         /// - update the monitor's state against resolved HTLCs
1265         /// - punish the counterparty in the case of seeing a revoked commitment transaction
1266         /// - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
1267         /// - detect settled outputs for later spending
1268         /// - schedule and bump any in-flight claims
1269         ///
1270         /// Returns any new outputs to watch from `txdata`; after called, these are also included in
1271         /// [`get_outputs_to_watch`].
1272         ///
1273         /// [`get_outputs_to_watch`]: #method.get_outputs_to_watch
1274         pub fn block_connected<B: Deref, F: Deref, L: Deref>(
1275                 &self,
1276                 header: &BlockHeader,
1277                 txdata: &TransactionData,
1278                 height: u32,
1279                 broadcaster: B,
1280                 fee_estimator: F,
1281                 logger: L,
1282         ) -> Vec<TransactionOutputs>
1283         where
1284                 B::Target: BroadcasterInterface,
1285                 F::Target: FeeEstimator,
1286                 L::Target: Logger,
1287         {
1288                 self.inner.lock().unwrap().block_connected(
1289                         header, txdata, height, broadcaster, fee_estimator, logger)
1290         }
1291
1292         /// Determines if the disconnected block contained any transactions of interest and updates
1293         /// appropriately.
1294         pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(
1295                 &self,
1296                 header: &BlockHeader,
1297                 height: u32,
1298                 broadcaster: B,
1299                 fee_estimator: F,
1300                 logger: L,
1301         ) where
1302                 B::Target: BroadcasterInterface,
1303                 F::Target: FeeEstimator,
1304                 L::Target: Logger,
1305         {
1306                 self.inner.lock().unwrap().block_disconnected(
1307                         header, height, broadcaster, fee_estimator, logger)
1308         }
1309
1310         /// Processes transactions confirmed in a block with the given header and height, returning new
1311         /// outputs to watch. See [`block_connected`] for details.
1312         ///
1313         /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1314         /// blocks. May be called before or after [`update_best_block`] for transactions in the
1315         /// corresponding block. See [`update_best_block`] for further calling expectations. 
1316         ///
1317         /// [`block_connected`]: Self::block_connected
1318         /// [`update_best_block`]: Self::update_best_block
1319         pub fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
1320                 &self,
1321                 header: &BlockHeader,
1322                 txdata: &TransactionData,
1323                 height: u32,
1324                 broadcaster: B,
1325                 fee_estimator: F,
1326                 logger: L,
1327         ) -> Vec<TransactionOutputs>
1328         where
1329                 B::Target: BroadcasterInterface,
1330                 F::Target: FeeEstimator,
1331                 L::Target: Logger,
1332         {
1333                 self.inner.lock().unwrap().transactions_confirmed(
1334                         header, txdata, height, broadcaster, fee_estimator, logger)
1335         }
1336
1337         /// Processes a transaction that was reorganized out of the chain.
1338         ///
1339         /// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
1340         /// than blocks. May be called before or after [`update_best_block`] for transactions in the
1341         /// corresponding block. See [`update_best_block`] for further calling expectations.
1342         ///
1343         /// [`block_disconnected`]: Self::block_disconnected
1344         /// [`update_best_block`]: Self::update_best_block
1345         pub fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
1346                 &self,
1347                 txid: &Txid,
1348                 broadcaster: B,
1349                 fee_estimator: F,
1350                 logger: L,
1351         ) where
1352                 B::Target: BroadcasterInterface,
1353                 F::Target: FeeEstimator,
1354                 L::Target: Logger,
1355         {
1356                 self.inner.lock().unwrap().transaction_unconfirmed(
1357                         txid, broadcaster, fee_estimator, logger);
1358         }
1359
1360         /// Updates the monitor with the current best chain tip, returning new outputs to watch. See
1361         /// [`block_connected`] for details.
1362         ///
1363         /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1364         /// blocks. May be called before or after [`transactions_confirmed`] for the corresponding
1365         /// block.
1366         ///
1367         /// Must be called after new blocks become available for the most recent block. Intermediary
1368         /// blocks, however, may be safely skipped. In the event of a chain re-organization, this only
1369         /// needs to be called for the most recent block assuming `transaction_unconfirmed` is called
1370         /// for any affected transactions.
1371         ///
1372         /// [`block_connected`]: Self::block_connected
1373         /// [`transactions_confirmed`]: Self::transactions_confirmed
1374         /// [`transaction_unconfirmed`]: Self::transaction_unconfirmed
1375         pub fn update_best_block<B: Deref, F: Deref, L: Deref>(
1376                 &self,
1377                 header: &BlockHeader,
1378                 height: u32,
1379                 broadcaster: B,
1380                 fee_estimator: F,
1381                 logger: L,
1382         ) -> Vec<TransactionOutputs>
1383         where
1384                 B::Target: BroadcasterInterface,
1385                 F::Target: FeeEstimator,
1386                 L::Target: Logger,
1387         {
1388                 self.inner.lock().unwrap().update_best_block(
1389                         header, height, broadcaster, fee_estimator, logger)
1390         }
1391
1392         /// Returns the set of txids that should be monitored for re-organization out of the chain.
1393         pub fn get_relevant_txids(&self) -> Vec<Txid> {
1394                 let inner = self.inner.lock().unwrap();
1395                 let mut txids: Vec<Txid> = inner.onchain_events_awaiting_threshold_conf
1396                         .iter()
1397                         .map(|entry| entry.txid)
1398                         .chain(inner.onchain_tx_handler.get_relevant_txids().into_iter())
1399                         .collect();
1400                 txids.sort_unstable();
1401                 txids.dedup();
1402                 txids
1403         }
1404 }
1405
1406 impl<Signer: Sign> ChannelMonitorImpl<Signer> {
1407         /// Inserts a revocation secret into this channel monitor. Prunes old preimages if neither
1408         /// needed by holder commitment transactions HTCLs nor by counterparty ones. Unless we haven't already seen
1409         /// counterparty commitment transaction's secret, they are de facto pruned (we can use revocation key).
1410         fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), MonitorUpdateError> {
1411                 if let Err(()) = self.commitment_secrets.provide_secret(idx, secret) {
1412                         return Err(MonitorUpdateError("Previous secret did not match new one"));
1413                 }
1414
1415                 // Prune HTLCs from the previous counterparty commitment tx so we don't generate failure/fulfill
1416                 // events for now-revoked/fulfilled HTLCs.
1417                 if let Some(txid) = self.prev_counterparty_commitment_txid.take() {
1418                         for &mut (_, ref mut source) in self.counterparty_claimable_outpoints.get_mut(&txid).unwrap() {
1419                                 *source = None;
1420                         }
1421                 }
1422
1423                 if !self.payment_preimages.is_empty() {
1424                         let cur_holder_signed_commitment_tx = &self.current_holder_commitment_tx;
1425                         let prev_holder_signed_commitment_tx = self.prev_holder_signed_commitment_tx.as_ref();
1426                         let min_idx = self.get_min_seen_secret();
1427                         let counterparty_hash_commitment_number = &mut self.counterparty_hash_commitment_number;
1428
1429                         self.payment_preimages.retain(|&k, _| {
1430                                 for &(ref htlc, _, _) in cur_holder_signed_commitment_tx.htlc_outputs.iter() {
1431                                         if k == htlc.payment_hash {
1432                                                 return true
1433                                         }
1434                                 }
1435                                 if let Some(prev_holder_commitment_tx) = prev_holder_signed_commitment_tx {
1436                                         for &(ref htlc, _, _) in prev_holder_commitment_tx.htlc_outputs.iter() {
1437                                                 if k == htlc.payment_hash {
1438                                                         return true
1439                                                 }
1440                                         }
1441                                 }
1442                                 let contains = if let Some(cn) = counterparty_hash_commitment_number.get(&k) {
1443                                         if *cn < min_idx {
1444                                                 return true
1445                                         }
1446                                         true
1447                                 } else { false };
1448                                 if contains {
1449                                         counterparty_hash_commitment_number.remove(&k);
1450                                 }
1451                                 false
1452                         });
1453                 }
1454
1455                 Ok(())
1456         }
1457
1458         pub(crate) fn provide_latest_counterparty_commitment_tx<L: Deref>(&mut self, txid: Txid, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>, commitment_number: u64, their_revocation_point: PublicKey, logger: &L) where L::Target: Logger {
1459                 // TODO: Encrypt the htlc_outputs data with the single-hash of the commitment transaction
1460                 // so that a remote monitor doesn't learn anything unless there is a malicious close.
1461                 // (only maybe, sadly we cant do the same for local info, as we need to be aware of
1462                 // timeouts)
1463                 for &(ref htlc, _) in &htlc_outputs {
1464                         self.counterparty_hash_commitment_number.insert(htlc.payment_hash, commitment_number);
1465                 }
1466
1467                 log_trace!(logger, "Tracking new counterparty commitment transaction with txid {} at commitment number {} with {} HTLC outputs", txid, commitment_number, htlc_outputs.len());
1468                 self.prev_counterparty_commitment_txid = self.current_counterparty_commitment_txid.take();
1469                 self.current_counterparty_commitment_txid = Some(txid);
1470                 self.counterparty_claimable_outpoints.insert(txid, htlc_outputs.clone());
1471                 self.current_counterparty_commitment_number = commitment_number;
1472                 //TODO: Merge this into the other per-counterparty-transaction output storage stuff
1473                 match self.their_cur_revocation_points {
1474                         Some(old_points) => {
1475                                 if old_points.0 == commitment_number + 1 {
1476                                         self.their_cur_revocation_points = Some((old_points.0, old_points.1, Some(their_revocation_point)));
1477                                 } else if old_points.0 == commitment_number + 2 {
1478                                         if let Some(old_second_point) = old_points.2 {
1479                                                 self.their_cur_revocation_points = Some((old_points.0 - 1, old_second_point, Some(their_revocation_point)));
1480                                         } else {
1481                                                 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1482                                         }
1483                                 } else {
1484                                         self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1485                                 }
1486                         },
1487                         None => {
1488                                 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1489                         }
1490                 }
1491                 let mut htlcs = Vec::with_capacity(htlc_outputs.len());
1492                 for htlc in htlc_outputs {
1493                         if htlc.0.transaction_output_index.is_some() {
1494                                 htlcs.push(htlc.0);
1495                         }
1496                 }
1497                 self.counterparty_tx_cache.per_htlc.insert(txid, htlcs);
1498         }
1499
1500         /// Informs this monitor of the latest holder (ie broadcastable) commitment transaction. The
1501         /// monitor watches for timeouts and may broadcast it if we approach such a timeout. Thus, it
1502         /// is important that any clones of this channel monitor (including remote clones) by kept
1503         /// up-to-date as our holder commitment transaction is updated.
1504         /// Panics if set_on_holder_tx_csv has never been called.
1505         fn provide_latest_holder_commitment_tx(&mut self, holder_commitment_tx: HolderCommitmentTransaction, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>) -> Result<(), MonitorUpdateError> {
1506                 // block for Rust 1.34 compat
1507                 let mut new_holder_commitment_tx = {
1508                         let trusted_tx = holder_commitment_tx.trust();
1509                         let txid = trusted_tx.txid();
1510                         let tx_keys = trusted_tx.keys();
1511                         self.current_holder_commitment_number = trusted_tx.commitment_number();
1512                         HolderSignedTx {
1513                                 txid,
1514                                 revocation_key: tx_keys.revocation_key,
1515                                 a_htlc_key: tx_keys.broadcaster_htlc_key,
1516                                 b_htlc_key: tx_keys.countersignatory_htlc_key,
1517                                 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
1518                                 per_commitment_point: tx_keys.per_commitment_point,
1519                                 feerate_per_kw: trusted_tx.feerate_per_kw(),
1520                                 htlc_outputs,
1521                         }
1522                 };
1523                 self.onchain_tx_handler.provide_latest_holder_tx(holder_commitment_tx);
1524                 mem::swap(&mut new_holder_commitment_tx, &mut self.current_holder_commitment_tx);
1525                 self.prev_holder_signed_commitment_tx = Some(new_holder_commitment_tx);
1526                 if self.holder_tx_signed {
1527                         return Err(MonitorUpdateError("Latest holder commitment signed has already been signed, update is rejected"));
1528                 }
1529                 Ok(())
1530         }
1531
1532         /// Provides a payment_hash->payment_preimage mapping. Will be automatically pruned when all
1533         /// commitment_tx_infos which contain the payment hash have been revoked.
1534         fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(&mut self, payment_hash: &PaymentHash, payment_preimage: &PaymentPreimage, broadcaster: &B, fee_estimator: &F, logger: &L)
1535         where B::Target: BroadcasterInterface,
1536                     F::Target: FeeEstimator,
1537                     L::Target: Logger,
1538         {
1539                 self.payment_preimages.insert(payment_hash.clone(), payment_preimage.clone());
1540
1541                 // If the channel is force closed, try to claim the output from this preimage.
1542                 // First check if a counterparty commitment transaction has been broadcasted:
1543                 macro_rules! claim_htlcs {
1544                         ($commitment_number: expr, $txid: expr) => {
1545                                 let htlc_claim_reqs = self.get_counterparty_htlc_output_claim_reqs($commitment_number, $txid, None);
1546                                 self.onchain_tx_handler.update_claims_view(&Vec::new(), htlc_claim_reqs, None, broadcaster, fee_estimator, logger);
1547                         }
1548                 }
1549                 if let Some(txid) = self.current_counterparty_commitment_txid {
1550                         if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
1551                                 claim_htlcs!(*commitment_number, txid);
1552                                 return;
1553                         }
1554                 }
1555                 if let Some(txid) = self.prev_counterparty_commitment_txid {
1556                         if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
1557                                 claim_htlcs!(*commitment_number, txid);
1558                                 return;
1559                         }
1560                 }
1561
1562                 // Then if a holder commitment transaction has been seen on-chain, broadcast transactions
1563                 // claiming the HTLC output from each of the holder commitment transactions.
1564                 // Note that we can't just use `self.holder_tx_signed`, because that only covers the case where
1565                 // *we* sign a holder commitment transaction, not when e.g. a watchtower broadcasts one of our
1566                 // holder commitment transactions.
1567                 if self.broadcasted_holder_revokable_script.is_some() {
1568                         let (claim_reqs, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx);
1569                         self.onchain_tx_handler.update_claims_view(&Vec::new(), claim_reqs, None, broadcaster, fee_estimator, logger);
1570                         if let Some(ref tx) = self.prev_holder_signed_commitment_tx {
1571                                 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&tx);
1572                                 self.onchain_tx_handler.update_claims_view(&Vec::new(), claim_reqs, None, broadcaster, fee_estimator, logger);
1573                         }
1574                 }
1575         }
1576
1577         pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(&mut self, broadcaster: &B, logger: &L)
1578                 where B::Target: BroadcasterInterface,
1579                                         L::Target: Logger,
1580         {
1581                 for tx in self.get_latest_holder_commitment_txn(logger).iter() {
1582                         broadcaster.broadcast_transaction(tx);
1583                 }
1584                 self.pending_monitor_events.push(MonitorEvent::CommitmentTxBroadcasted(self.funding_info.0));
1585         }
1586
1587         pub fn update_monitor<B: Deref, F: Deref, L: Deref>(&mut self, updates: &ChannelMonitorUpdate, broadcaster: &B, fee_estimator: &F, logger: &L) -> Result<(), MonitorUpdateError>
1588         where B::Target: BroadcasterInterface,
1589                     F::Target: FeeEstimator,
1590                     L::Target: Logger,
1591         {
1592                 // ChannelMonitor updates may be applied after force close if we receive a
1593                 // preimage for a broadcasted commitment transaction HTLC output that we'd
1594                 // like to claim on-chain. If this is the case, we no longer have guaranteed
1595                 // access to the monitor's update ID, so we use a sentinel value instead.
1596                 if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
1597                         match updates.updates[0] {
1598                                 ChannelMonitorUpdateStep::PaymentPreimage { .. } => {},
1599                                 _ => panic!("Attempted to apply post-force-close ChannelMonitorUpdate that wasn't providing a payment preimage"),
1600                         }
1601                         assert_eq!(updates.updates.len(), 1);
1602                 } else if self.latest_update_id + 1 != updates.update_id {
1603                         panic!("Attempted to apply ChannelMonitorUpdates out of order, check the update_id before passing an update to update_monitor!");
1604                 }
1605                 for update in updates.updates.iter() {
1606                         match update {
1607                                 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { commitment_tx, htlc_outputs } => {
1608                                         log_trace!(logger, "Updating ChannelMonitor with latest holder commitment transaction info");
1609                                         if self.lockdown_from_offchain { panic!(); }
1610                                         self.provide_latest_holder_commitment_tx(commitment_tx.clone(), htlc_outputs.clone())?
1611                                 }
1612                                 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid, htlc_outputs, commitment_number, their_revocation_point } => {
1613                                         log_trace!(logger, "Updating ChannelMonitor with latest counterparty commitment transaction info");
1614                                         self.provide_latest_counterparty_commitment_tx(*commitment_txid, htlc_outputs.clone(), *commitment_number, *their_revocation_point, logger)
1615                                 },
1616                                 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } => {
1617                                         log_trace!(logger, "Updating ChannelMonitor with payment preimage");
1618                                         self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage, broadcaster, fee_estimator, logger)
1619                                 },
1620                                 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } => {
1621                                         log_trace!(logger, "Updating ChannelMonitor with commitment secret");
1622                                         self.provide_secret(*idx, *secret)?
1623                                 },
1624                                 ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } => {
1625                                         log_trace!(logger, "Updating ChannelMonitor: channel force closed, should broadcast: {}", should_broadcast);
1626                                         self.lockdown_from_offchain = true;
1627                                         if *should_broadcast {
1628                                                 self.broadcast_latest_holder_commitment_txn(broadcaster, logger);
1629                                         } else if !self.holder_tx_signed {
1630                                                 log_error!(logger, "You have a toxic holder commitment transaction avaible in channel monitor, read comment in ChannelMonitor::get_latest_holder_commitment_txn to be informed of manual action to take");
1631                                         } else {
1632                                                 // If we generated a MonitorEvent::CommitmentTxBroadcasted, the ChannelManager
1633                                                 // will still give us a ChannelForceClosed event with !should_broadcast, but we
1634                                                 // shouldn't print the scary warning above.
1635                                                 log_info!(logger, "Channel off-chain state closed after we broadcasted our latest commitment transaction.");
1636                                         }
1637                                 }
1638                         }
1639                 }
1640                 self.latest_update_id = updates.update_id;
1641                 Ok(())
1642         }
1643
1644         pub fn get_latest_update_id(&self) -> u64 {
1645                 self.latest_update_id
1646         }
1647
1648         pub fn get_funding_txo(&self) -> &(OutPoint, Script) {
1649                 &self.funding_info
1650         }
1651
1652         pub fn get_outputs_to_watch(&self) -> &HashMap<Txid, Vec<(u32, Script)>> {
1653                 // If we've detected a counterparty commitment tx on chain, we must include it in the set
1654                 // of outputs to watch for spends of, otherwise we're likely to lose user funds. Because
1655                 // its trivial to do, double-check that here.
1656                 for (txid, _) in self.counterparty_commitment_txn_on_chain.iter() {
1657                         self.outputs_to_watch.get(txid).expect("Counterparty commitment txn which have been broadcast should have outputs registered");
1658                 }
1659                 &self.outputs_to_watch
1660         }
1661
1662         pub fn get_and_clear_pending_monitor_events(&mut self) -> Vec<MonitorEvent> {
1663                 let mut ret = Vec::new();
1664                 mem::swap(&mut ret, &mut self.pending_monitor_events);
1665                 ret
1666         }
1667
1668         pub fn get_and_clear_pending_events(&mut self) -> Vec<Event> {
1669                 let mut ret = Vec::new();
1670                 mem::swap(&mut ret, &mut self.pending_events);
1671                 ret
1672         }
1673
1674         /// Can only fail if idx is < get_min_seen_secret
1675         fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
1676                 self.commitment_secrets.get_secret(idx)
1677         }
1678
1679         pub(crate) fn get_min_seen_secret(&self) -> u64 {
1680                 self.commitment_secrets.get_min_seen_secret()
1681         }
1682
1683         pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
1684                 self.current_counterparty_commitment_number
1685         }
1686
1687         pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
1688                 self.current_holder_commitment_number
1689         }
1690
1691         /// Attempts to claim a counterparty commitment transaction's outputs using the revocation key and
1692         /// data in counterparty_claimable_outpoints. Will directly claim any HTLC outputs which expire at a
1693         /// height > height + CLTV_SHARED_CLAIM_BUFFER. In any case, will install monitoring for
1694         /// HTLC-Success/HTLC-Timeout transactions.
1695         /// Return updates for HTLC pending in the channel and failed automatically by the broadcast of
1696         /// revoked counterparty commitment tx
1697         fn check_spend_counterparty_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) -> (Vec<ClaimRequest>, TransactionOutputs) where L::Target: Logger {
1698                 // Most secp and related errors trying to create keys means we have no hope of constructing
1699                 // a spend transaction...so we return no transactions to broadcast
1700                 let mut claimable_outpoints = Vec::new();
1701                 let mut watch_outputs = Vec::new();
1702
1703                 let commitment_txid = tx.txid(); //TODO: This is gonna be a performance bottleneck for watchtowers!
1704                 let per_commitment_option = self.counterparty_claimable_outpoints.get(&commitment_txid);
1705
1706                 macro_rules! ignore_error {
1707                         ( $thing : expr ) => {
1708                                 match $thing {
1709                                         Ok(a) => a,
1710                                         Err(_) => return (claimable_outpoints, (commitment_txid, watch_outputs))
1711                                 }
1712                         };
1713                 }
1714
1715                 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);
1716                 if commitment_number >= self.get_min_seen_secret() {
1717                         let secret = self.get_secret(commitment_number).unwrap();
1718                         let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
1719                         let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
1720                         let revocation_pubkey = ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint));
1721                         let delayed_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key), &self.counterparty_tx_cache.counterparty_delayed_payment_base_key));
1722
1723                         let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.counterparty_tx_cache.on_counterparty_tx_csv, &delayed_key);
1724                         let revokeable_p2wsh = revokeable_redeemscript.to_v0_p2wsh();
1725
1726                         // First, process non-htlc outputs (to_holder & to_counterparty)
1727                         for (idx, outp) in tx.output.iter().enumerate() {
1728                                 if outp.script_pubkey == revokeable_p2wsh {
1729                                         let witness_data = InputMaterial::Revoked { per_commitment_point, counterparty_delayed_payment_base_key: self.counterparty_tx_cache.counterparty_delayed_payment_base_key, counterparty_htlc_base_key: self.counterparty_tx_cache.counterparty_htlc_base_key, per_commitment_key, input_descriptor: InputDescriptors::RevokedOutput, amount: outp.value, htlc: None, on_counterparty_tx_csv: self.counterparty_tx_cache.on_counterparty_tx_csv};
1730                                         claimable_outpoints.push(ClaimRequest { absolute_timelock: height + self.counterparty_tx_cache.on_counterparty_tx_csv as u32, aggregable: true, outpoint: BitcoinOutPoint { txid: commitment_txid, vout: idx as u32 }, witness_data});
1731                                 }
1732                         }
1733
1734                         // Then, try to find revoked htlc outputs
1735                         if let Some(ref per_commitment_data) = per_commitment_option {
1736                                 for (_, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
1737                                         if let Some(transaction_output_index) = htlc.transaction_output_index {
1738                                                 if transaction_output_index as usize >= tx.output.len() ||
1739                                                                 tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
1740                                                         return (claimable_outpoints, (commitment_txid, watch_outputs)); // Corrupted per_commitment_data, fuck this user
1741                                                 }
1742                                                 let witness_data = InputMaterial::Revoked { per_commitment_point, counterparty_delayed_payment_base_key: self.counterparty_tx_cache.counterparty_delayed_payment_base_key, counterparty_htlc_base_key: self.counterparty_tx_cache.counterparty_htlc_base_key, per_commitment_key, input_descriptor: if htlc.offered { InputDescriptors::RevokedOfferedHTLC } else { InputDescriptors::RevokedReceivedHTLC }, amount: tx.output[transaction_output_index as usize].value, htlc: Some(htlc.clone()), on_counterparty_tx_csv: self.counterparty_tx_cache.on_counterparty_tx_csv};
1743                                                 claimable_outpoints.push(ClaimRequest { absolute_timelock: htlc.cltv_expiry, aggregable: true, outpoint: BitcoinOutPoint { txid: commitment_txid, vout: transaction_output_index }, witness_data });
1744                                         }
1745                                 }
1746                         }
1747
1748                         // Last, track onchain revoked commitment transaction and fail backward outgoing HTLCs as payment path is broken
1749                         if !claimable_outpoints.is_empty() || per_commitment_option.is_some() { // ie we're confident this is actually ours
1750                                 // We're definitely a counterparty commitment transaction!
1751                                 log_trace!(logger, "Got broadcast of revoked counterparty commitment transaction, going to generate general spend tx with {} inputs", claimable_outpoints.len());
1752                                 for (idx, outp) in tx.output.iter().enumerate() {
1753                                         watch_outputs.push((idx as u32, outp.clone()));
1754                                 }
1755                                 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
1756
1757                                 macro_rules! check_htlc_fails {
1758                                         ($txid: expr, $commitment_tx: expr) => {
1759                                                 if let Some(ref outpoints) = self.counterparty_claimable_outpoints.get($txid) {
1760                                                         for &(ref htlc, ref source_option) in outpoints.iter() {
1761                                                                 if let &Some(ref source) = source_option {
1762                                                                         self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
1763                                                                                 if entry.height != height { return true; }
1764                                                                                 match entry.event {
1765                                                                                          OnchainEvent::HTLCUpdate { ref htlc_update } => {
1766                                                                                                  htlc_update.0 != **source
1767                                                                                          },
1768                                                                                          _ => true,
1769                                                                                 }
1770                                                                         });
1771                                                                         let entry = OnchainEventEntry {
1772                                                                                 txid: *$txid,
1773                                                                                 height,
1774                                                                                 event: OnchainEvent::HTLCUpdate {
1775                                                                                         htlc_update: ((**source).clone(), htlc.payment_hash.clone())
1776                                                                                 },
1777                                                                         };
1778                                                                         log_info!(logger, "Failing HTLC with payment_hash {} from {} counterparty commitment tx due to broadcast of revoked counterparty commitment transaction, waiting for confirmation (at height {})", log_bytes!(htlc.payment_hash.0), $commitment_tx, entry.confirmation_threshold());
1779                                                                         self.onchain_events_awaiting_threshold_conf.push(entry);
1780                                                                 }
1781                                                         }
1782                                                 }
1783                                         }
1784                                 }
1785                                 if let Some(ref txid) = self.current_counterparty_commitment_txid {
1786                                         check_htlc_fails!(txid, "current");
1787                                 }
1788                                 if let Some(ref txid) = self.prev_counterparty_commitment_txid {
1789                                         check_htlc_fails!(txid, "counterparty");
1790                                 }
1791                                 // No need to check holder commitment txn, symmetric HTLCSource must be present as per-htlc data on counterparty commitment tx
1792                         }
1793                 } else if let Some(per_commitment_data) = per_commitment_option {
1794                         // While this isn't useful yet, there is a potential race where if a counterparty
1795                         // revokes a state at the same time as the commitment transaction for that state is
1796                         // confirmed, and the watchtower receives the block before the user, the user could
1797                         // upload a new ChannelMonitor with the revocation secret but the watchtower has
1798                         // already processed the block, resulting in the counterparty_commitment_txn_on_chain entry
1799                         // not being generated by the above conditional. Thus, to be safe, we go ahead and
1800                         // insert it here.
1801                         for (idx, outp) in tx.output.iter().enumerate() {
1802                                 watch_outputs.push((idx as u32, outp.clone()));
1803                         }
1804                         self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
1805
1806                         log_trace!(logger, "Got broadcast of non-revoked counterparty commitment transaction {}", commitment_txid);
1807
1808                         macro_rules! check_htlc_fails {
1809                                 ($txid: expr, $commitment_tx: expr, $id: tt) => {
1810                                         if let Some(ref latest_outpoints) = self.counterparty_claimable_outpoints.get($txid) {
1811                                                 $id: for &(ref htlc, ref source_option) in latest_outpoints.iter() {
1812                                                         if let &Some(ref source) = source_option {
1813                                                                 // Check if the HTLC is present in the commitment transaction that was
1814                                                                 // broadcast, but not if it was below the dust limit, which we should
1815                                                                 // fail backwards immediately as there is no way for us to learn the
1816                                                                 // payment_preimage.
1817                                                                 // Note that if the dust limit were allowed to change between
1818                                                                 // commitment transactions we'd want to be check whether *any*
1819                                                                 // broadcastable commitment transaction has the HTLC in it, but it
1820                                                                 // cannot currently change after channel initialization, so we don't
1821                                                                 // need to here.
1822                                                                 for &(ref broadcast_htlc, ref broadcast_source) in per_commitment_data.iter() {
1823                                                                         if broadcast_htlc.transaction_output_index.is_some() && Some(source) == broadcast_source.as_ref() {
1824                                                                                 continue $id;
1825                                                                         }
1826                                                                 }
1827                                                                 log_trace!(logger, "Failing HTLC with payment_hash {} from {} counterparty commitment tx due to broadcast of counterparty commitment transaction", log_bytes!(htlc.payment_hash.0), $commitment_tx);
1828                                                                 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
1829                                                                         if entry.height != height { return true; }
1830                                                                         match entry.event {
1831                                                                                  OnchainEvent::HTLCUpdate { ref htlc_update } => {
1832                                                                                          htlc_update.0 != **source
1833                                                                                  },
1834                                                                                  _ => true,
1835                                                                         }
1836                                                                 });
1837                                                                 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
1838                                                                         txid: *$txid,
1839                                                                         height,
1840                                                                         event: OnchainEvent::HTLCUpdate {
1841                                                                                 htlc_update: ((**source).clone(), htlc.payment_hash.clone())
1842                                                                         },
1843                                                                 });
1844                                                         }
1845                                                 }
1846                                         }
1847                                 }
1848                         }
1849                         if let Some(ref txid) = self.current_counterparty_commitment_txid {
1850                                 check_htlc_fails!(txid, "current", 'current_loop);
1851                         }
1852                         if let Some(ref txid) = self.prev_counterparty_commitment_txid {
1853                                 check_htlc_fails!(txid, "previous", 'prev_loop);
1854                         }
1855
1856                         let htlc_claim_reqs = self.get_counterparty_htlc_output_claim_reqs(commitment_number, commitment_txid, Some(tx));
1857                         for req in htlc_claim_reqs {
1858                                 claimable_outpoints.push(req);
1859                         }
1860
1861                 }
1862                 (claimable_outpoints, (commitment_txid, watch_outputs))
1863         }
1864
1865         fn get_counterparty_htlc_output_claim_reqs(&self, commitment_number: u64, commitment_txid: Txid, tx: Option<&Transaction>) -> Vec<ClaimRequest> {
1866                 let mut claims = Vec::new();
1867                 if let Some(htlc_outputs) = self.counterparty_claimable_outpoints.get(&commitment_txid) {
1868                         if let Some(revocation_points) = self.their_cur_revocation_points {
1869                                 let revocation_point_option =
1870                                         // If the counterparty commitment tx is the latest valid state, use their latest
1871                                         // per-commitment point
1872                                         if revocation_points.0 == commitment_number { Some(&revocation_points.1) }
1873                                         else if let Some(point) = revocation_points.2.as_ref() {
1874                                                 // If counterparty commitment tx is the state previous to the latest valid state, use
1875                                                 // their previous per-commitment point (non-atomicity of revocation means it's valid for
1876                                                 // them to temporarily have two valid commitment txns from our viewpoint)
1877                                                 if revocation_points.0 == commitment_number + 1 { Some(point) } else { None }
1878                                         } else { None };
1879                                 if let Some(revocation_point) = revocation_point_option {
1880                                         for (_, &(ref htlc, _)) in htlc_outputs.iter().enumerate() {
1881                                                 if let Some(transaction_output_index) = htlc.transaction_output_index {
1882                                                         if let Some(transaction) = tx {
1883                                                                 if transaction_output_index as usize >= transaction.output.len() ||
1884                                                                         transaction.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
1885                                                                                 return claims; // Corrupted per_commitment_data, fuck this user
1886                                                                         }
1887                                                         }
1888                                                         let preimage =
1889                                                                 if htlc.offered {
1890                                                                         if let Some(p) = self.payment_preimages.get(&htlc.payment_hash) {
1891                                                                                 Some(*p)
1892                                                                         } else { None }
1893                                                                 } else { None };
1894                                                         let aggregable = if !htlc.offered { false } else { true };
1895                                                         if preimage.is_some() || !htlc.offered {
1896                                                                 let witness_data = InputMaterial::CounterpartyHTLC { per_commitment_point: *revocation_point, counterparty_delayed_payment_base_key: self.counterparty_tx_cache.counterparty_delayed_payment_base_key, counterparty_htlc_base_key: self.counterparty_tx_cache.counterparty_htlc_base_key, preimage, htlc: htlc.clone() };
1897                                                                 claims.push(ClaimRequest { absolute_timelock: htlc.cltv_expiry, aggregable, outpoint: BitcoinOutPoint { txid: commitment_txid, vout: transaction_output_index }, witness_data });
1898                                                         }
1899                                                 }
1900                                         }
1901                                 }
1902                         }
1903                 }
1904                 claims
1905         }
1906
1907         /// Attempts to claim a counterparty HTLC-Success/HTLC-Timeout's outputs using the revocation key
1908         fn check_spend_counterparty_htlc<L: Deref>(&mut self, tx: &Transaction, commitment_number: u64, height: u32, logger: &L) -> (Vec<ClaimRequest>, Option<TransactionOutputs>) where L::Target: Logger {
1909                 let htlc_txid = tx.txid();
1910                 if tx.input.len() != 1 || tx.output.len() != 1 || tx.input[0].witness.len() != 5 {
1911                         return (Vec::new(), None)
1912                 }
1913
1914                 macro_rules! ignore_error {
1915                         ( $thing : expr ) => {
1916                                 match $thing {
1917                                         Ok(a) => a,
1918                                         Err(_) => return (Vec::new(), None)
1919                                 }
1920                         };
1921                 }
1922
1923                 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
1924                 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
1925                 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
1926
1927                 log_trace!(logger, "Counterparty HTLC broadcast {}:{}", htlc_txid, 0);
1928                 let witness_data = InputMaterial::Revoked { per_commitment_point, counterparty_delayed_payment_base_key: self.counterparty_tx_cache.counterparty_delayed_payment_base_key, counterparty_htlc_base_key: self.counterparty_tx_cache.counterparty_htlc_base_key,  per_commitment_key, input_descriptor: InputDescriptors::RevokedOutput, amount: tx.output[0].value, htlc: None, on_counterparty_tx_csv: self.counterparty_tx_cache.on_counterparty_tx_csv };
1929                 let claimable_outpoints = vec!(ClaimRequest { absolute_timelock: height + self.counterparty_tx_cache.on_counterparty_tx_csv as u32, aggregable: true, outpoint: BitcoinOutPoint { txid: htlc_txid, vout: 0}, witness_data });
1930                 let outputs = vec![(0, tx.output[0].clone())];
1931                 (claimable_outpoints, Some((htlc_txid, outputs)))
1932         }
1933
1934         // Returns (1) `ClaimRequest`s that can be given to the OnChainTxHandler, so that the handler can
1935         // broadcast transactions claiming holder HTLC commitment outputs and (2) a holder revokable
1936         // script so we can detect whether a holder transaction has been seen on-chain.
1937         fn get_broadcasted_holder_claims(&self, holder_tx: &HolderSignedTx) -> (Vec<ClaimRequest>, Option<(Script, PublicKey, PublicKey)>) {
1938                 let mut claim_requests = Vec::with_capacity(holder_tx.htlc_outputs.len());
1939
1940                 let redeemscript = chan_utils::get_revokeable_redeemscript(&holder_tx.revocation_key, self.on_holder_tx_csv, &holder_tx.delayed_payment_key);
1941                 let broadcasted_holder_revokable_script = Some((redeemscript.to_v0_p2wsh(), holder_tx.per_commitment_point.clone(), holder_tx.revocation_key.clone()));
1942
1943                 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
1944                         if let Some(transaction_output_index) = htlc.transaction_output_index {
1945                                 claim_requests.push(ClaimRequest { absolute_timelock: ::std::u32::MAX, aggregable: false, outpoint: BitcoinOutPoint { txid: holder_tx.txid, vout: transaction_output_index as u32 },
1946                                         witness_data: InputMaterial::HolderHTLC {
1947                                                 preimage: if !htlc.offered {
1948                                                                 if let Some(preimage) = self.payment_preimages.get(&htlc.payment_hash) {
1949                                                                         Some(preimage.clone())
1950                                                                 } else {
1951                                                                         // We can't build an HTLC-Success transaction without the preimage
1952                                                                         continue;
1953                                                                 }
1954                                                         } else { None },
1955                                                 amount: htlc.amount_msat,
1956                                 }});
1957                         }
1958                 }
1959
1960                 (claim_requests, broadcasted_holder_revokable_script)
1961         }
1962
1963         // Returns holder HTLC outputs to watch and react to in case of spending.
1964         fn get_broadcasted_holder_watch_outputs(&self, holder_tx: &HolderSignedTx, commitment_tx: &Transaction) -> Vec<(u32, TxOut)> {
1965                 let mut watch_outputs = Vec::with_capacity(holder_tx.htlc_outputs.len());
1966                 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
1967                         if let Some(transaction_output_index) = htlc.transaction_output_index {
1968                                 watch_outputs.push((transaction_output_index, commitment_tx.output[transaction_output_index as usize].clone()));
1969                         }
1970                 }
1971                 watch_outputs
1972         }
1973
1974         /// Attempts to claim any claimable HTLCs in a commitment transaction which was not (yet)
1975         /// revoked using data in holder_claimable_outpoints.
1976         /// Should not be used if check_spend_revoked_transaction succeeds.
1977         fn check_spend_holder_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) -> (Vec<ClaimRequest>, TransactionOutputs) where L::Target: Logger {
1978                 let commitment_txid = tx.txid();
1979                 let mut claim_requests = Vec::new();
1980                 let mut watch_outputs = Vec::new();
1981
1982                 macro_rules! wait_threshold_conf {
1983                         ($source: expr, $commitment_tx: expr, $payment_hash: expr) => {
1984                                 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
1985                                         if entry.height != height { return true; }
1986                                         match entry.event {
1987                                                  OnchainEvent::HTLCUpdate { ref htlc_update } => {
1988                                                          htlc_update.0 != $source
1989                                                  },
1990                                                  _ => true,
1991                                         }
1992                                 });
1993                                 let entry = OnchainEventEntry {
1994                                         txid: commitment_txid,
1995                                         height,
1996                                         event: OnchainEvent::HTLCUpdate { htlc_update: ($source, $payment_hash) },
1997                                 };
1998                                 log_trace!(logger, "Failing HTLC with payment_hash {} from {} holder commitment tx due to broadcast of transaction, waiting confirmation (at height{})", log_bytes!($payment_hash.0), $commitment_tx, entry.confirmation_threshold());
1999                                 self.onchain_events_awaiting_threshold_conf.push(entry);
2000                         }
2001                 }
2002
2003                 macro_rules! append_onchain_update {
2004                         ($updates: expr, $to_watch: expr) => {
2005                                 claim_requests = $updates.0;
2006                                 self.broadcasted_holder_revokable_script = $updates.1;
2007                                 watch_outputs.append(&mut $to_watch);
2008                         }
2009                 }
2010
2011                 // HTLCs set may differ between last and previous holder commitment txn, in case of one them hitting chain, ensure we cancel all HTLCs backward
2012                 let mut is_holder_tx = false;
2013
2014                 if self.current_holder_commitment_tx.txid == commitment_txid {
2015                         is_holder_tx = true;
2016                         log_trace!(logger, "Got latest holder commitment tx broadcast, searching for available HTLCs to claim");
2017                         let res = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx);
2018                         let mut to_watch = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, tx);
2019                         append_onchain_update!(res, to_watch);
2020                 } else if let &Some(ref holder_tx) = &self.prev_holder_signed_commitment_tx {
2021                         if holder_tx.txid == commitment_txid {
2022                                 is_holder_tx = true;
2023                                 log_trace!(logger, "Got previous holder commitment tx broadcast, searching for available HTLCs to claim");
2024                                 let res = self.get_broadcasted_holder_claims(holder_tx);
2025                                 let mut to_watch = self.get_broadcasted_holder_watch_outputs(holder_tx, tx);
2026                                 append_onchain_update!(res, to_watch);
2027                         }
2028                 }
2029
2030                 macro_rules! fail_dust_htlcs_after_threshold_conf {
2031                         ($holder_tx: expr) => {
2032                                 for &(ref htlc, _, ref source) in &$holder_tx.htlc_outputs {
2033                                         if htlc.transaction_output_index.is_none() {
2034                                                 if let &Some(ref source) = source {
2035                                                         wait_threshold_conf!(source.clone(), "lastest", htlc.payment_hash.clone());
2036                                                 }
2037                                         }
2038                                 }
2039                         }
2040                 }
2041
2042                 if is_holder_tx {
2043                         fail_dust_htlcs_after_threshold_conf!(self.current_holder_commitment_tx);
2044                         if let &Some(ref holder_tx) = &self.prev_holder_signed_commitment_tx {
2045                                 fail_dust_htlcs_after_threshold_conf!(holder_tx);
2046                         }
2047                 }
2048
2049                 (claim_requests, (commitment_txid, watch_outputs))
2050         }
2051
2052         pub fn get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
2053                 log_trace!(logger, "Getting signed latest holder commitment transaction!");
2054                 self.holder_tx_signed = true;
2055                 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
2056                 let txid = commitment_tx.txid();
2057                 let mut res = vec![commitment_tx];
2058                 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
2059                         if let Some(vout) = htlc.0.transaction_output_index {
2060                                 let preimage = if !htlc.0.offered {
2061                                         if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
2062                                                 // We can't build an HTLC-Success transaction without the preimage
2063                                                 continue;
2064                                         }
2065                                 } else { None };
2066                                 if let Some(htlc_tx) = self.onchain_tx_handler.get_fully_signed_htlc_tx(
2067                                         &::bitcoin::OutPoint { txid, vout }, &preimage) {
2068                                         res.push(htlc_tx);
2069                                 }
2070                         }
2071                 }
2072                 // 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.
2073                 // The data will be re-generated and tracked in check_spend_holder_transaction if we get a confirmation.
2074                 return res;
2075         }
2076
2077         #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
2078         fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
2079                 log_trace!(logger, "Getting signed copy of latest holder commitment transaction!");
2080                 let commitment_tx = self.onchain_tx_handler.get_fully_signed_copy_holder_tx(&self.funding_redeemscript);
2081                 let txid = commitment_tx.txid();
2082                 let mut res = vec![commitment_tx];
2083                 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
2084                         if let Some(vout) = htlc.0.transaction_output_index {
2085                                 let preimage = if !htlc.0.offered {
2086                                         if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
2087                                                 // We can't build an HTLC-Success transaction without the preimage
2088                                                 continue;
2089                                         }
2090                                 } else { None };
2091                                 if let Some(htlc_tx) = self.onchain_tx_handler.unsafe_get_fully_signed_htlc_tx(
2092                                         &::bitcoin::OutPoint { txid, vout }, &preimage) {
2093                                         res.push(htlc_tx);
2094                                 }
2095                         }
2096                 }
2097                 return res
2098         }
2099
2100         pub fn block_connected<B: Deref, F: Deref, L: Deref>(&mut self, header: &BlockHeader, txdata: &TransactionData, height: u32, broadcaster: B, fee_estimator: F, logger: L) -> Vec<TransactionOutputs>
2101                 where B::Target: BroadcasterInterface,
2102                       F::Target: FeeEstimator,
2103                                         L::Target: Logger,
2104         {
2105                 let block_hash = header.block_hash();
2106                 log_trace!(logger, "New best block {} at height {}", block_hash, height);
2107                 self.best_block = BestBlock::new(block_hash, height);
2108
2109                 self.transactions_confirmed(header, txdata, height, broadcaster, fee_estimator, logger)
2110         }
2111
2112         fn update_best_block<B: Deref, F: Deref, L: Deref>(
2113                 &mut self,
2114                 header: &BlockHeader,
2115                 height: u32,
2116                 broadcaster: B,
2117                 fee_estimator: F,
2118                 logger: L,
2119         ) -> Vec<TransactionOutputs>
2120         where
2121                 B::Target: BroadcasterInterface,
2122                 F::Target: FeeEstimator,
2123                 L::Target: Logger,
2124         {
2125                 let block_hash = header.block_hash();
2126                 log_trace!(logger, "New best block {} at height {}", block_hash, height);
2127
2128                 if height > self.best_block.height() {
2129                         self.best_block = BestBlock::new(block_hash, height);
2130                         self.block_confirmed(height, vec![], vec![], vec![], broadcaster, fee_estimator, logger)
2131                 } else {
2132                         self.best_block = BestBlock::new(block_hash, height);
2133                         self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height <= height);
2134                         self.onchain_tx_handler.block_disconnected(height + 1, broadcaster, fee_estimator, logger);
2135                         Vec::new()
2136                 }
2137         }
2138
2139         fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
2140                 &mut self,
2141                 header: &BlockHeader,
2142                 txdata: &TransactionData,
2143                 height: u32,
2144                 broadcaster: B,
2145                 fee_estimator: F,
2146                 logger: L,
2147         ) -> Vec<TransactionOutputs>
2148         where
2149                 B::Target: BroadcasterInterface,
2150                 F::Target: FeeEstimator,
2151                 L::Target: Logger,
2152         {
2153                 let txn_matched = self.filter_block(txdata);
2154                 for tx in &txn_matched {
2155                         let mut output_val = 0;
2156                         for out in tx.output.iter() {
2157                                 if out.value > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
2158                                 output_val += out.value;
2159                                 if output_val > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
2160                         }
2161                 }
2162
2163                 let block_hash = header.block_hash();
2164                 log_trace!(logger, "Block {} at height {} connected with {} txn matched", block_hash, height, txn_matched.len());
2165
2166                 let mut watch_outputs = Vec::new();
2167                 let mut claimable_outpoints = Vec::new();
2168                 for tx in &txn_matched {
2169                         if tx.input.len() == 1 {
2170                                 // Assuming our keys were not leaked (in which case we're screwed no matter what),
2171                                 // commitment transactions and HTLC transactions will all only ever have one input,
2172                                 // which is an easy way to filter out any potential non-matching txn for lazy
2173                                 // filters.
2174                                 let prevout = &tx.input[0].previous_output;
2175                                 if prevout.txid == self.funding_info.0.txid && prevout.vout == self.funding_info.0.index as u32 {
2176                                         if (tx.input[0].sequence >> 8*3) as u8 == 0x80 && (tx.lock_time >> 8*3) as u8 == 0x20 {
2177                                                 let (mut new_outpoints, new_outputs) = self.check_spend_counterparty_transaction(&tx, height, &logger);
2178                                                 if !new_outputs.1.is_empty() {
2179                                                         watch_outputs.push(new_outputs);
2180                                                 }
2181                                                 if new_outpoints.is_empty() {
2182                                                         let (mut new_outpoints, new_outputs) = self.check_spend_holder_transaction(&tx, height, &logger);
2183                                                         if !new_outputs.1.is_empty() {
2184                                                                 watch_outputs.push(new_outputs);
2185                                                         }
2186                                                         claimable_outpoints.append(&mut new_outpoints);
2187                                                 }
2188                                                 claimable_outpoints.append(&mut new_outpoints);
2189                                         }
2190                                 } else {
2191                                         if let Some(&commitment_number) = self.counterparty_commitment_txn_on_chain.get(&prevout.txid) {
2192                                                 let (mut new_outpoints, new_outputs_option) = self.check_spend_counterparty_htlc(&tx, commitment_number, height, &logger);
2193                                                 claimable_outpoints.append(&mut new_outpoints);
2194                                                 if let Some(new_outputs) = new_outputs_option {
2195                                                         watch_outputs.push(new_outputs);
2196                                                 }
2197                                         }
2198                                 }
2199                         }
2200                         // While all commitment/HTLC-Success/HTLC-Timeout transactions have one input, HTLCs
2201                         // can also be resolved in a few other ways which can have more than one output. Thus,
2202                         // we call is_resolving_htlc_output here outside of the tx.input.len() == 1 check.
2203                         self.is_resolving_htlc_output(&tx, height, &logger);
2204
2205                         self.is_paying_spendable_output(&tx, height, &logger);
2206                 }
2207
2208                 self.block_confirmed(height, txn_matched, watch_outputs, claimable_outpoints, broadcaster, fee_estimator, logger)
2209         }
2210
2211         fn block_confirmed<B: Deref, F: Deref, L: Deref>(
2212                 &mut self,
2213                 height: u32,
2214                 txn_matched: Vec<&Transaction>,
2215                 mut watch_outputs: Vec<TransactionOutputs>,
2216                 mut claimable_outpoints: Vec<ClaimRequest>,
2217                 broadcaster: B,
2218                 fee_estimator: F,
2219                 logger: L,
2220         ) -> Vec<TransactionOutputs>
2221         where
2222                 B::Target: BroadcasterInterface,
2223                 F::Target: FeeEstimator,
2224                 L::Target: Logger,
2225         {
2226                 let should_broadcast = self.would_broadcast_at_height(height, &logger);
2227                 if should_broadcast {
2228                         claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, outpoint: BitcoinOutPoint { txid: self.funding_info.0.txid.clone(), vout: self.funding_info.0.index as u32 }, witness_data: InputMaterial::Funding { funding_redeemscript: self.funding_redeemscript.clone() }});
2229                         self.pending_monitor_events.push(MonitorEvent::CommitmentTxBroadcasted(self.funding_info.0));
2230                         let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
2231                         self.holder_tx_signed = true;
2232                         let (mut new_outpoints, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx);
2233                         let new_outputs = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, &commitment_tx);
2234                         if !new_outputs.is_empty() {
2235                                 watch_outputs.push((self.current_holder_commitment_tx.txid.clone(), new_outputs));
2236                         }
2237                         claimable_outpoints.append(&mut new_outpoints);
2238                 }
2239
2240                 // Find which on-chain events have reached their confirmation threshold.
2241                 let onchain_events_awaiting_threshold_conf =
2242                         self.onchain_events_awaiting_threshold_conf.drain(..).collect::<Vec<_>>();
2243                 let mut onchain_events_reaching_threshold_conf = Vec::new();
2244                 for entry in onchain_events_awaiting_threshold_conf {
2245                         if entry.has_reached_confirmation_threshold(height) {
2246                                 onchain_events_reaching_threshold_conf.push(entry);
2247                         } else {
2248                                 self.onchain_events_awaiting_threshold_conf.push(entry);
2249                         }
2250                 }
2251
2252                 // Used to check for duplicate HTLC resolutions.
2253                 #[cfg(debug_assertions)]
2254                 let unmatured_htlcs: Vec<_> = self.onchain_events_awaiting_threshold_conf
2255                         .iter()
2256                         .filter_map(|entry| match &entry.event {
2257                                 OnchainEvent::HTLCUpdate { htlc_update } => Some(htlc_update.0.clone()),
2258                                 OnchainEvent::MaturingOutput { .. } => None,
2259                         })
2260                         .collect();
2261                 #[cfg(debug_assertions)]
2262                 let mut matured_htlcs = Vec::new();
2263
2264                 // Produce actionable events from on-chain events having reached their threshold.
2265                 for entry in onchain_events_reaching_threshold_conf.drain(..) {
2266                         match entry.event {
2267                                 OnchainEvent::HTLCUpdate { htlc_update } => {
2268                                         // Check for duplicate HTLC resolutions.
2269                                         #[cfg(debug_assertions)]
2270                                         {
2271                                                 debug_assert!(
2272                                                         unmatured_htlcs.iter().find(|&htlc| htlc == &htlc_update.0).is_none(),
2273                                                         "An unmature HTLC transaction conflicts with a maturing one; failed to \
2274                                                          call either transaction_unconfirmed for the conflicting transaction \
2275                                                          or block_disconnected for a block containing it.");
2276                                                 debug_assert!(
2277                                                         matured_htlcs.iter().find(|&htlc| htlc == &htlc_update.0).is_none(),
2278                                                         "A matured HTLC transaction conflicts with a maturing one; failed to \
2279                                                          call either transaction_unconfirmed for the conflicting transaction \
2280                                                          or block_disconnected for a block containing it.");
2281                                                 matured_htlcs.push(htlc_update.0.clone());
2282                                         }
2283
2284                                         log_trace!(logger, "HTLC {} failure update has got enough confirmations to be passed upstream", log_bytes!((htlc_update.1).0));
2285                                         self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
2286                                                 payment_hash: htlc_update.1,
2287                                                 payment_preimage: None,
2288                                                 source: htlc_update.0,
2289                                         }));
2290                                 },
2291                                 OnchainEvent::MaturingOutput { descriptor } => {
2292                                         log_trace!(logger, "Descriptor {} has got enough confirmations to be passed upstream", log_spendable!(descriptor));
2293                                         self.pending_events.push(Event::SpendableOutputs {
2294                                                 outputs: vec![descriptor]
2295                                         });
2296                                 }
2297                         }
2298                 }
2299
2300                 self.onchain_tx_handler.update_claims_view(&txn_matched, claimable_outpoints, Some(height), &&*broadcaster, &&*fee_estimator, &&*logger);
2301
2302                 // Determine new outputs to watch by comparing against previously known outputs to watch,
2303                 // updating the latter in the process.
2304                 watch_outputs.retain(|&(ref txid, ref txouts)| {
2305                         let idx_and_scripts = txouts.iter().map(|o| (o.0, o.1.script_pubkey.clone())).collect();
2306                         self.outputs_to_watch.insert(txid.clone(), idx_and_scripts).is_none()
2307                 });
2308                 #[cfg(test)]
2309                 {
2310                         // If we see a transaction for which we registered outputs previously,
2311                         // make sure the registered scriptpubkey at the expected index match
2312                         // the actual transaction output one. We failed this case before #653.
2313                         for tx in &txn_matched {
2314                                 if let Some(outputs) = self.get_outputs_to_watch().get(&tx.txid()) {
2315                                         for idx_and_script in outputs.iter() {
2316                                                 assert!((idx_and_script.0 as usize) < tx.output.len());
2317                                                 assert_eq!(tx.output[idx_and_script.0 as usize].script_pubkey, idx_and_script.1);
2318                                         }
2319                                 }
2320                         }
2321                 }
2322                 watch_outputs
2323         }
2324
2325         pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, header: &BlockHeader, height: u32, broadcaster: B, fee_estimator: F, logger: L)
2326                 where B::Target: BroadcasterInterface,
2327                       F::Target: FeeEstimator,
2328                       L::Target: Logger,
2329         {
2330                 log_trace!(logger, "Block {} at height {} disconnected", header.block_hash(), height);
2331
2332                 //We may discard:
2333                 //- htlc update there as failure-trigger tx (revoked commitment tx, non-revoked commitment tx, HTLC-timeout tx) has been disconnected
2334                 //- maturing spendable output has transaction paying us has been disconnected
2335                 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height < height);
2336
2337                 self.onchain_tx_handler.block_disconnected(height, broadcaster, fee_estimator, logger);
2338
2339                 self.best_block = BestBlock::new(header.prev_blockhash, height - 1);
2340         }
2341
2342         fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
2343                 &mut self,
2344                 txid: &Txid,
2345                 broadcaster: B,
2346                 fee_estimator: F,
2347                 logger: L,
2348         ) where
2349                 B::Target: BroadcasterInterface,
2350                 F::Target: FeeEstimator,
2351                 L::Target: Logger,
2352         {
2353                 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.txid != *txid);
2354                 self.onchain_tx_handler.transaction_unconfirmed(txid, broadcaster, fee_estimator, logger);
2355         }
2356
2357         /// Filters a block's `txdata` for transactions spending watched outputs or for any child
2358         /// transactions thereof.
2359         fn filter_block<'a>(&self, txdata: &TransactionData<'a>) -> Vec<&'a Transaction> {
2360                 let mut matched_txn = HashSet::new();
2361                 txdata.iter().filter(|&&(_, tx)| {
2362                         let mut matches = self.spends_watched_output(tx);
2363                         for input in tx.input.iter() {
2364                                 if matches { break; }
2365                                 if matched_txn.contains(&input.previous_output.txid) {
2366                                         matches = true;
2367                                 }
2368                         }
2369                         if matches {
2370                                 matched_txn.insert(tx.txid());
2371                         }
2372                         matches
2373                 }).map(|(_, tx)| *tx).collect()
2374         }
2375
2376         /// Checks if a given transaction spends any watched outputs.
2377         fn spends_watched_output(&self, tx: &Transaction) -> bool {
2378                 for input in tx.input.iter() {
2379                         if let Some(outputs) = self.get_outputs_to_watch().get(&input.previous_output.txid) {
2380                                 for (idx, _script_pubkey) in outputs.iter() {
2381                                         if *idx == input.previous_output.vout {
2382                                                 #[cfg(test)]
2383                                                 {
2384                                                         // If the expected script is a known type, check that the witness
2385                                                         // appears to be spending the correct type (ie that the match would
2386                                                         // actually succeed in BIP 158/159-style filters).
2387                                                         if _script_pubkey.is_v0_p2wsh() {
2388                                                                 assert_eq!(&bitcoin::Address::p2wsh(&Script::from(input.witness.last().unwrap().clone()), bitcoin::Network::Bitcoin).script_pubkey(), _script_pubkey);
2389                                                         } else if _script_pubkey.is_v0_p2wpkh() {
2390                                                                 assert_eq!(&bitcoin::Address::p2wpkh(&bitcoin::PublicKey::from_slice(&input.witness.last().unwrap()).unwrap(), bitcoin::Network::Bitcoin).unwrap().script_pubkey(), _script_pubkey);
2391                                                         } else { panic!(); }
2392                                                 }
2393                                                 return true;
2394                                         }
2395                                 }
2396                         }
2397                 }
2398
2399                 false
2400         }
2401
2402         fn would_broadcast_at_height<L: Deref>(&self, height: u32, logger: &L) -> bool where L::Target: Logger {
2403                 // We need to consider all HTLCs which are:
2404                 //  * in any unrevoked counterparty commitment transaction, as they could broadcast said
2405                 //    transactions and we'd end up in a race, or
2406                 //  * are in our latest holder commitment transaction, as this is the thing we will
2407                 //    broadcast if we go on-chain.
2408                 // Note that we consider HTLCs which were below dust threshold here - while they don't
2409                 // strictly imply that we need to fail the channel, we need to go ahead and fail them back
2410                 // to the source, and if we don't fail the channel we will have to ensure that the next
2411                 // updates that peer sends us are update_fails, failing the channel if not. It's probably
2412                 // easier to just fail the channel as this case should be rare enough anyway.
2413                 macro_rules! scan_commitment {
2414                         ($htlcs: expr, $holder_tx: expr) => {
2415                                 for ref htlc in $htlcs {
2416                                         // For inbound HTLCs which we know the preimage for, we have to ensure we hit the
2417                                         // chain with enough room to claim the HTLC without our counterparty being able to
2418                                         // time out the HTLC first.
2419                                         // For outbound HTLCs which our counterparty hasn't failed/claimed, our primary
2420                                         // concern is being able to claim the corresponding inbound HTLC (on another
2421                                         // channel) before it expires. In fact, we don't even really care if our
2422                                         // counterparty here claims such an outbound HTLC after it expired as long as we
2423                                         // can still claim the corresponding HTLC. Thus, to avoid needlessly hitting the
2424                                         // chain when our counterparty is waiting for expiration to off-chain fail an HTLC
2425                                         // we give ourselves a few blocks of headroom after expiration before going
2426                                         // on-chain for an expired HTLC.
2427                                         // Note that, to avoid a potential attack whereby a node delays claiming an HTLC
2428                                         // from us until we've reached the point where we go on-chain with the
2429                                         // corresponding inbound HTLC, we must ensure that outbound HTLCs go on chain at
2430                                         // least CLTV_CLAIM_BUFFER blocks prior to the inbound HTLC.
2431                                         //  aka outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS == height - CLTV_CLAIM_BUFFER
2432                                         //      inbound_cltv == height + CLTV_CLAIM_BUFFER
2433                                         //      outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS + CLTV_CLAIM_BUFFER <= inbound_cltv - CLTV_CLAIM_BUFFER
2434                                         //      LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= inbound_cltv - outbound_cltv
2435                                         //      CLTV_EXPIRY_DELTA <= inbound_cltv - outbound_cltv (by check in ChannelManager::decode_update_add_htlc_onion)
2436                                         //      LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= CLTV_EXPIRY_DELTA
2437                                         //  The final, above, condition is checked for statically in channelmanager
2438                                         //  with CHECK_CLTV_EXPIRY_SANITY_2.
2439                                         let htlc_outbound = $holder_tx == htlc.offered;
2440                                         if ( htlc_outbound && htlc.cltv_expiry + LATENCY_GRACE_PERIOD_BLOCKS <= height) ||
2441                                            (!htlc_outbound && htlc.cltv_expiry <= height + CLTV_CLAIM_BUFFER && self.payment_preimages.contains_key(&htlc.payment_hash)) {
2442                                                 log_info!(logger, "Force-closing channel due to {} HTLC timeout, HTLC expiry is {}", if htlc_outbound { "outbound" } else { "inbound "}, htlc.cltv_expiry);
2443                                                 return true;
2444                                         }
2445                                 }
2446                         }
2447                 }
2448
2449                 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
2450
2451                 if let Some(ref txid) = self.current_counterparty_commitment_txid {
2452                         if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
2453                                 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
2454                         }
2455                 }
2456                 if let Some(ref txid) = self.prev_counterparty_commitment_txid {
2457                         if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
2458                                 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
2459                         }
2460                 }
2461
2462                 false
2463         }
2464
2465         /// Check if any transaction broadcasted is resolving HTLC output by a success or timeout on a holder
2466         /// or counterparty commitment tx, if so send back the source, preimage if found and payment_hash of resolved HTLC
2467         fn is_resolving_htlc_output<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) where L::Target: Logger {
2468                 'outer_loop: for input in &tx.input {
2469                         let mut payment_data = None;
2470                         let revocation_sig_claim = (input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::OfferedHTLC) && input.witness[1].len() == 33)
2471                                 || (input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::AcceptedHTLC) && input.witness[1].len() == 33);
2472                         let accepted_preimage_claim = input.witness.len() == 5 && HTLCType::scriptlen_to_htlctype(input.witness[4].len()) == Some(HTLCType::AcceptedHTLC);
2473                         let offered_preimage_claim = input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::OfferedHTLC);
2474
2475                         macro_rules! log_claim {
2476                                 ($tx_info: expr, $holder_tx: expr, $htlc: expr, $source_avail: expr) => {
2477                                         // We found the output in question, but aren't failing it backwards
2478                                         // as we have no corresponding source and no valid counterparty commitment txid
2479                                         // to try a weak source binding with same-hash, same-value still-valid offered HTLC.
2480                                         // This implies either it is an inbound HTLC or an outbound HTLC on a revoked transaction.
2481                                         let outbound_htlc = $holder_tx == $htlc.offered;
2482                                         if ($holder_tx && revocation_sig_claim) ||
2483                                                         (outbound_htlc && !$source_avail && (accepted_preimage_claim || offered_preimage_claim)) {
2484                                                 log_error!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}!",
2485                                                         $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
2486                                                         if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
2487                                                         if revocation_sig_claim { "revocation sig" } else { "preimage claim after we'd passed the HTLC resolution back" });
2488                                         } else {
2489                                                 log_info!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}",
2490                                                         $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
2491                                                         if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
2492                                                         if revocation_sig_claim { "revocation sig" } else if accepted_preimage_claim || offered_preimage_claim { "preimage" } else { "timeout" });
2493                                         }
2494                                 }
2495                         }
2496
2497                         macro_rules! check_htlc_valid_counterparty {
2498                                 ($counterparty_txid: expr, $htlc_output: expr) => {
2499                                         if let Some(txid) = $counterparty_txid {
2500                                                 for &(ref pending_htlc, ref pending_source) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
2501                                                         if pending_htlc.payment_hash == $htlc_output.payment_hash && pending_htlc.amount_msat == $htlc_output.amount_msat {
2502                                                                 if let &Some(ref source) = pending_source {
2503                                                                         log_claim!("revoked counterparty commitment tx", false, pending_htlc, true);
2504                                                                         payment_data = Some(((**source).clone(), $htlc_output.payment_hash));
2505                                                                         break;
2506                                                                 }
2507                                                         }
2508                                                 }
2509                                         }
2510                                 }
2511                         }
2512
2513                         macro_rules! scan_commitment {
2514                                 ($htlcs: expr, $tx_info: expr, $holder_tx: expr) => {
2515                                         for (ref htlc_output, source_option) in $htlcs {
2516                                                 if Some(input.previous_output.vout) == htlc_output.transaction_output_index {
2517                                                         if let Some(ref source) = source_option {
2518                                                                 log_claim!($tx_info, $holder_tx, htlc_output, true);
2519                                                                 // We have a resolution of an HTLC either from one of our latest
2520                                                                 // holder commitment transactions or an unrevoked counterparty commitment
2521                                                                 // transaction. This implies we either learned a preimage, the HTLC
2522                                                                 // has timed out, or we screwed up. In any case, we should now
2523                                                                 // resolve the source HTLC with the original sender.
2524                                                                 payment_data = Some(((*source).clone(), htlc_output.payment_hash));
2525                                                         } else if !$holder_tx {
2526                                                                         check_htlc_valid_counterparty!(self.current_counterparty_commitment_txid, htlc_output);
2527                                                                 if payment_data.is_none() {
2528                                                                         check_htlc_valid_counterparty!(self.prev_counterparty_commitment_txid, htlc_output);
2529                                                                 }
2530                                                         }
2531                                                         if payment_data.is_none() {
2532                                                                 log_claim!($tx_info, $holder_tx, htlc_output, false);
2533                                                                 continue 'outer_loop;
2534                                                         }
2535                                                 }
2536                                         }
2537                                 }
2538                         }
2539
2540                         if input.previous_output.txid == self.current_holder_commitment_tx.txid {
2541                                 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
2542                                         "our latest holder commitment tx", true);
2543                         }
2544                         if let Some(ref prev_holder_signed_commitment_tx) = self.prev_holder_signed_commitment_tx {
2545                                 if input.previous_output.txid == prev_holder_signed_commitment_tx.txid {
2546                                         scan_commitment!(prev_holder_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
2547                                                 "our previous holder commitment tx", true);
2548                                 }
2549                         }
2550                         if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(&input.previous_output.txid) {
2551                                 scan_commitment!(htlc_outputs.iter().map(|&(ref a, ref b)| (a, (b.as_ref().clone()).map(|boxed| &**boxed))),
2552                                         "counterparty commitment tx", false);
2553                         }
2554
2555                         // Check that scan_commitment, above, decided there is some source worth relaying an
2556                         // HTLC resolution backwards to and figure out whether we learned a preimage from it.
2557                         if let Some((source, payment_hash)) = payment_data {
2558                                 let mut payment_preimage = PaymentPreimage([0; 32]);
2559                                 if accepted_preimage_claim {
2560                                         if !self.pending_monitor_events.iter().any(
2561                                                 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update { upd.source == source } else { false }) {
2562                                                 payment_preimage.0.copy_from_slice(&input.witness[3]);
2563                                                 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
2564                                                         source,
2565                                                         payment_preimage: Some(payment_preimage),
2566                                                         payment_hash
2567                                                 }));
2568                                         }
2569                                 } else if offered_preimage_claim {
2570                                         if !self.pending_monitor_events.iter().any(
2571                                                 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update {
2572                                                         upd.source == source
2573                                                 } else { false }) {
2574                                                 payment_preimage.0.copy_from_slice(&input.witness[1]);
2575                                                 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
2576                                                         source,
2577                                                         payment_preimage: Some(payment_preimage),
2578                                                         payment_hash
2579                                                 }));
2580                                         }
2581                                 } else {
2582                                         self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
2583                                                 if entry.height != height { return true; }
2584                                                 match entry.event {
2585                                                          OnchainEvent::HTLCUpdate { ref htlc_update } => {
2586                                                                  htlc_update.0 != source
2587                                                          },
2588                                                          _ => true,
2589                                                 }
2590                                         });
2591                                         let entry = OnchainEventEntry {
2592                                                 txid: tx.txid(),
2593                                                 height,
2594                                                 event: OnchainEvent::HTLCUpdate { htlc_update: (source, payment_hash) },
2595                                         };
2596                                         log_info!(logger, "Failing HTLC with payment_hash {} timeout by a spend tx, waiting for confirmation (at height{})", log_bytes!(payment_hash.0), entry.confirmation_threshold());
2597                                         self.onchain_events_awaiting_threshold_conf.push(entry);
2598                                 }
2599                         }
2600                 }
2601         }
2602
2603         /// Check if any transaction broadcasted is paying fund back to some address we can assume to own
2604         fn is_paying_spendable_output<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) where L::Target: Logger {
2605                 let mut spendable_output = None;
2606                 for (i, outp) in tx.output.iter().enumerate() { // There is max one spendable output for any channel tx, including ones generated by us
2607                         if i > ::std::u16::MAX as usize {
2608                                 // While it is possible that an output exists on chain which is greater than the
2609                                 // 2^16th output in a given transaction, this is only possible if the output is not
2610                                 // in a lightning transaction and was instead placed there by some third party who
2611                                 // wishes to give us money for no reason.
2612                                 // Namely, any lightning transactions which we pre-sign will never have anywhere
2613                                 // near 2^16 outputs both because such transactions must have ~2^16 outputs who's
2614                                 // scripts are not longer than one byte in length and because they are inherently
2615                                 // non-standard due to their size.
2616                                 // Thus, it is completely safe to ignore such outputs, and while it may result in
2617                                 // us ignoring non-lightning fund to us, that is only possible if someone fills
2618                                 // nearly a full block with garbage just to hit this case.
2619                                 continue;
2620                         }
2621                         if outp.script_pubkey == self.destination_script {
2622                                 spendable_output =  Some(SpendableOutputDescriptor::StaticOutput {
2623                                         outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
2624                                         output: outp.clone(),
2625                                 });
2626                                 break;
2627                         } else if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
2628                                 if broadcasted_holder_revokable_script.0 == outp.script_pubkey {
2629                                         spendable_output =  Some(SpendableOutputDescriptor::DelayedPaymentOutput(DelayedPaymentOutputDescriptor {
2630                                                 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
2631                                                 per_commitment_point: broadcasted_holder_revokable_script.1,
2632                                                 to_self_delay: self.on_holder_tx_csv,
2633                                                 output: outp.clone(),
2634                                                 revocation_pubkey: broadcasted_holder_revokable_script.2.clone(),
2635                                                 channel_keys_id: self.channel_keys_id,
2636                                                 channel_value_satoshis: self.channel_value_satoshis,
2637                                         }));
2638                                         break;
2639                                 }
2640                         } else if self.counterparty_payment_script == outp.script_pubkey {
2641                                 spendable_output = Some(SpendableOutputDescriptor::StaticPaymentOutput(StaticPaymentOutputDescriptor {
2642                                         outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
2643                                         output: outp.clone(),
2644                                         channel_keys_id: self.channel_keys_id,
2645                                         channel_value_satoshis: self.channel_value_satoshis,
2646                                 }));
2647                                 break;
2648                         } else if outp.script_pubkey == self.shutdown_script {
2649                                 spendable_output = Some(SpendableOutputDescriptor::StaticOutput {
2650                                         outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
2651                                         output: outp.clone(),
2652                                 });
2653                         }
2654                 }
2655                 if let Some(spendable_output) = spendable_output {
2656                         let entry = OnchainEventEntry {
2657                                 txid: tx.txid(),
2658                                 height: height,
2659                                 event: OnchainEvent::MaturingOutput { descriptor: spendable_output.clone() },
2660                         };
2661                         log_trace!(logger, "Maturing {} until {}", log_spendable!(spendable_output), entry.confirmation_threshold());
2662                         self.onchain_events_awaiting_threshold_conf.push(entry);
2663                 }
2664         }
2665 }
2666
2667 /// `Persist` defines behavior for persisting channel monitors: this could mean
2668 /// writing once to disk, and/or uploading to one or more backup services.
2669 ///
2670 /// Note that for every new monitor, you **must** persist the new `ChannelMonitor`
2671 /// to disk/backups. And, on every update, you **must** persist either the
2672 /// `ChannelMonitorUpdate` or the updated monitor itself. Otherwise, there is risk
2673 /// of situations such as revoking a transaction, then crashing before this
2674 /// revocation can be persisted, then unintentionally broadcasting a revoked
2675 /// transaction and losing money. This is a risk because previous channel states
2676 /// are toxic, so it's important that whatever channel state is persisted is
2677 /// kept up-to-date.
2678 pub trait Persist<ChannelSigner: Sign>: Send + Sync {
2679         /// Persist a new channel's data. The data can be stored any way you want, but
2680         /// the identifier provided by Rust-Lightning is the channel's outpoint (and
2681         /// it is up to you to maintain a correct mapping between the outpoint and the
2682         /// stored channel data). Note that you **must** persist every new monitor to
2683         /// disk. See the `Persist` trait documentation for more details.
2684         ///
2685         /// See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`,
2686         /// and [`ChannelMonitorUpdateErr`] for requirements when returning errors.
2687         fn persist_new_channel(&self, id: OutPoint, data: &ChannelMonitor<ChannelSigner>) -> Result<(), ChannelMonitorUpdateErr>;
2688
2689         /// Update one channel's data. The provided `ChannelMonitor` has already
2690         /// applied the given update.
2691         ///
2692         /// Note that on every update, you **must** persist either the
2693         /// `ChannelMonitorUpdate` or the updated monitor itself to disk/backups. See
2694         /// the `Persist` trait documentation for more details.
2695         ///
2696         /// If an implementer chooses to persist the updates only, they need to make
2697         /// sure that all the updates are applied to the `ChannelMonitors` *before*
2698         /// the set of channel monitors is given to the `ChannelManager`
2699         /// deserialization routine. See [`ChannelMonitor::update_monitor`] for
2700         /// applying a monitor update to a monitor. If full `ChannelMonitors` are
2701         /// persisted, then there is no need to persist individual updates.
2702         ///
2703         /// Note that there could be a performance tradeoff between persisting complete
2704         /// channel monitors on every update vs. persisting only updates and applying
2705         /// them in batches. The size of each monitor grows `O(number of state updates)`
2706         /// whereas updates are small and `O(1)`.
2707         ///
2708         /// See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`,
2709         /// [`ChannelMonitorUpdate::write`] for writing out an update, and
2710         /// [`ChannelMonitorUpdateErr`] for requirements when returning errors.
2711         fn update_persisted_channel(&self, id: OutPoint, update: &ChannelMonitorUpdate, data: &ChannelMonitor<ChannelSigner>) -> Result<(), ChannelMonitorUpdateErr>;
2712 }
2713
2714 impl<Signer: Sign, T: Deref, F: Deref, L: Deref> chain::Listen for (ChannelMonitor<Signer>, T, F, L)
2715 where
2716         T::Target: BroadcasterInterface,
2717         F::Target: FeeEstimator,
2718         L::Target: Logger,
2719 {
2720         fn block_connected(&self, block: &Block, height: u32) {
2721                 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
2722                 self.0.block_connected(&block.header, &txdata, height, &*self.1, &*self.2, &*self.3);
2723         }
2724
2725         fn block_disconnected(&self, header: &BlockHeader, height: u32) {
2726                 self.0.block_disconnected(header, height, &*self.1, &*self.2, &*self.3);
2727         }
2728 }
2729
2730 const MAX_ALLOC_SIZE: usize = 64*1024;
2731
2732 impl<'a, Signer: Sign, K: KeysInterface<Signer = Signer>> ReadableArgs<&'a K>
2733                 for (BlockHash, ChannelMonitor<Signer>) {
2734         fn read<R: ::std::io::Read>(reader: &mut R, keys_manager: &'a K) -> Result<Self, DecodeError> {
2735                 macro_rules! unwrap_obj {
2736                         ($key: expr) => {
2737                                 match $key {
2738                                         Ok(res) => res,
2739                                         Err(_) => return Err(DecodeError::InvalidValue),
2740                                 }
2741                         }
2742                 }
2743
2744                 let _ver: u8 = Readable::read(reader)?;
2745                 let min_ver: u8 = Readable::read(reader)?;
2746                 if min_ver > SERIALIZATION_VERSION {
2747                         return Err(DecodeError::UnknownVersion);
2748                 }
2749
2750                 let latest_update_id: u64 = Readable::read(reader)?;
2751                 let commitment_transaction_number_obscure_factor = <U48 as Readable>::read(reader)?.0;
2752
2753                 let destination_script = Readable::read(reader)?;
2754                 let broadcasted_holder_revokable_script = match <u8 as Readable>::read(reader)? {
2755                         0 => {
2756                                 let revokable_address = Readable::read(reader)?;
2757                                 let per_commitment_point = Readable::read(reader)?;
2758                                 let revokable_script = Readable::read(reader)?;
2759                                 Some((revokable_address, per_commitment_point, revokable_script))
2760                         },
2761                         1 => { None },
2762                         _ => return Err(DecodeError::InvalidValue),
2763                 };
2764                 let counterparty_payment_script = Readable::read(reader)?;
2765                 let shutdown_script = Readable::read(reader)?;
2766
2767                 let channel_keys_id = Readable::read(reader)?;
2768                 let holder_revocation_basepoint = Readable::read(reader)?;
2769                 // Technically this can fail and serialize fail a round-trip, but only for serialization of
2770                 // barely-init'd ChannelMonitors that we can't do anything with.
2771                 let outpoint = OutPoint {
2772                         txid: Readable::read(reader)?,
2773                         index: Readable::read(reader)?,
2774                 };
2775                 let funding_info = (outpoint, Readable::read(reader)?);
2776                 let current_counterparty_commitment_txid = Readable::read(reader)?;
2777                 let prev_counterparty_commitment_txid = Readable::read(reader)?;
2778
2779                 let counterparty_tx_cache = Readable::read(reader)?;
2780                 let funding_redeemscript = Readable::read(reader)?;
2781                 let channel_value_satoshis = Readable::read(reader)?;
2782
2783                 let their_cur_revocation_points = {
2784                         let first_idx = <U48 as Readable>::read(reader)?.0;
2785                         if first_idx == 0 {
2786                                 None
2787                         } else {
2788                                 let first_point = Readable::read(reader)?;
2789                                 let second_point_slice: [u8; 33] = Readable::read(reader)?;
2790                                 if second_point_slice[0..32] == [0; 32] && second_point_slice[32] == 0 {
2791                                         Some((first_idx, first_point, None))
2792                                 } else {
2793                                         Some((first_idx, first_point, Some(unwrap_obj!(PublicKey::from_slice(&second_point_slice)))))
2794                                 }
2795                         }
2796                 };
2797
2798                 let on_holder_tx_csv: u16 = Readable::read(reader)?;
2799
2800                 let commitment_secrets = Readable::read(reader)?;
2801
2802                 macro_rules! read_htlc_in_commitment {
2803                         () => {
2804                                 {
2805                                         let offered: bool = Readable::read(reader)?;
2806                                         let amount_msat: u64 = Readable::read(reader)?;
2807                                         let cltv_expiry: u32 = Readable::read(reader)?;
2808                                         let payment_hash: PaymentHash = Readable::read(reader)?;
2809                                         let transaction_output_index: Option<u32> = Readable::read(reader)?;
2810
2811                                         HTLCOutputInCommitment {
2812                                                 offered, amount_msat, cltv_expiry, payment_hash, transaction_output_index
2813                                         }
2814                                 }
2815                         }
2816                 }
2817
2818                 let counterparty_claimable_outpoints_len: u64 = Readable::read(reader)?;
2819                 let mut counterparty_claimable_outpoints = HashMap::with_capacity(cmp::min(counterparty_claimable_outpoints_len as usize, MAX_ALLOC_SIZE / 64));
2820                 for _ in 0..counterparty_claimable_outpoints_len {
2821                         let txid: Txid = Readable::read(reader)?;
2822                         let htlcs_count: u64 = Readable::read(reader)?;
2823                         let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
2824                         for _ in 0..htlcs_count {
2825                                 htlcs.push((read_htlc_in_commitment!(), <Option<HTLCSource> as Readable>::read(reader)?.map(|o: HTLCSource| Box::new(o))));
2826                         }
2827                         if let Some(_) = counterparty_claimable_outpoints.insert(txid, htlcs) {
2828                                 return Err(DecodeError::InvalidValue);
2829                         }
2830                 }
2831
2832                 let counterparty_commitment_txn_on_chain_len: u64 = Readable::read(reader)?;
2833                 let mut counterparty_commitment_txn_on_chain = HashMap::with_capacity(cmp::min(counterparty_commitment_txn_on_chain_len as usize, MAX_ALLOC_SIZE / 32));
2834                 for _ in 0..counterparty_commitment_txn_on_chain_len {
2835                         let txid: Txid = Readable::read(reader)?;
2836                         let commitment_number = <U48 as Readable>::read(reader)?.0;
2837                         if let Some(_) = counterparty_commitment_txn_on_chain.insert(txid, commitment_number) {
2838                                 return Err(DecodeError::InvalidValue);
2839                         }
2840                 }
2841
2842                 let counterparty_hash_commitment_number_len: u64 = Readable::read(reader)?;
2843                 let mut counterparty_hash_commitment_number = HashMap::with_capacity(cmp::min(counterparty_hash_commitment_number_len as usize, MAX_ALLOC_SIZE / 32));
2844                 for _ in 0..counterparty_hash_commitment_number_len {
2845                         let payment_hash: PaymentHash = Readable::read(reader)?;
2846                         let commitment_number = <U48 as Readable>::read(reader)?.0;
2847                         if let Some(_) = counterparty_hash_commitment_number.insert(payment_hash, commitment_number) {
2848                                 return Err(DecodeError::InvalidValue);
2849                         }
2850                 }
2851
2852                 macro_rules! read_holder_tx {
2853                         () => {
2854                                 {
2855                                         let txid = Readable::read(reader)?;
2856                                         let revocation_key = Readable::read(reader)?;
2857                                         let a_htlc_key = Readable::read(reader)?;
2858                                         let b_htlc_key = Readable::read(reader)?;
2859                                         let delayed_payment_key = Readable::read(reader)?;
2860                                         let per_commitment_point = Readable::read(reader)?;
2861                                         let feerate_per_kw: u32 = Readable::read(reader)?;
2862
2863                                         let htlcs_len: u64 = Readable::read(reader)?;
2864                                         let mut htlcs = Vec::with_capacity(cmp::min(htlcs_len as usize, MAX_ALLOC_SIZE / 128));
2865                                         for _ in 0..htlcs_len {
2866                                                 let htlc = read_htlc_in_commitment!();
2867                                                 let sigs = match <u8 as Readable>::read(reader)? {
2868                                                         0 => None,
2869                                                         1 => Some(Readable::read(reader)?),
2870                                                         _ => return Err(DecodeError::InvalidValue),
2871                                                 };
2872                                                 htlcs.push((htlc, sigs, Readable::read(reader)?));
2873                                         }
2874
2875                                         HolderSignedTx {
2876                                                 txid,
2877                                                 revocation_key, a_htlc_key, b_htlc_key, delayed_payment_key, per_commitment_point, feerate_per_kw,
2878                                                 htlc_outputs: htlcs
2879                                         }
2880                                 }
2881                         }
2882                 }
2883
2884                 let prev_holder_signed_commitment_tx = match <u8 as Readable>::read(reader)? {
2885                         0 => None,
2886                         1 => {
2887                                 Some(read_holder_tx!())
2888                         },
2889                         _ => return Err(DecodeError::InvalidValue),
2890                 };
2891                 let current_holder_commitment_tx = read_holder_tx!();
2892
2893                 let current_counterparty_commitment_number = <U48 as Readable>::read(reader)?.0;
2894                 let current_holder_commitment_number = <U48 as Readable>::read(reader)?.0;
2895
2896                 let payment_preimages_len: u64 = Readable::read(reader)?;
2897                 let mut payment_preimages = HashMap::with_capacity(cmp::min(payment_preimages_len as usize, MAX_ALLOC_SIZE / 32));
2898                 for _ in 0..payment_preimages_len {
2899                         let preimage: PaymentPreimage = Readable::read(reader)?;
2900                         let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
2901                         if let Some(_) = payment_preimages.insert(hash, preimage) {
2902                                 return Err(DecodeError::InvalidValue);
2903                         }
2904                 }
2905
2906                 let pending_monitor_events_len: u64 = Readable::read(reader)?;
2907                 let mut pending_monitor_events = Vec::with_capacity(cmp::min(pending_monitor_events_len as usize, MAX_ALLOC_SIZE / (32 + 8*3)));
2908                 for _ in 0..pending_monitor_events_len {
2909                         let ev = match <u8 as Readable>::read(reader)? {
2910                                 0 => MonitorEvent::HTLCEvent(Readable::read(reader)?),
2911                                 1 => MonitorEvent::CommitmentTxBroadcasted(funding_info.0),
2912                                 _ => return Err(DecodeError::InvalidValue)
2913                         };
2914                         pending_monitor_events.push(ev);
2915                 }
2916
2917                 let pending_events_len: u64 = Readable::read(reader)?;
2918                 let mut pending_events = Vec::with_capacity(cmp::min(pending_events_len as usize, MAX_ALLOC_SIZE / mem::size_of::<Event>()));
2919                 for _ in 0..pending_events_len {
2920                         if let Some(event) = MaybeReadable::read(reader)? {
2921                                 pending_events.push(event);
2922                         }
2923                 }
2924
2925                 let best_block = BestBlock::new(Readable::read(reader)?, Readable::read(reader)?);
2926
2927                 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
2928                 let mut onchain_events_awaiting_threshold_conf = Vec::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
2929                 for _ in 0..waiting_threshold_conf_len {
2930                         let txid = Readable::read(reader)?;
2931                         let height = Readable::read(reader)?;
2932                         let event = match <u8 as Readable>::read(reader)? {
2933                                 0 => {
2934                                         let htlc_source = Readable::read(reader)?;
2935                                         let hash = Readable::read(reader)?;
2936                                         OnchainEvent::HTLCUpdate {
2937                                                 htlc_update: (htlc_source, hash)
2938                                         }
2939                                 },
2940                                 1 => {
2941                                         let descriptor = Readable::read(reader)?;
2942                                         OnchainEvent::MaturingOutput {
2943                                                 descriptor
2944                                         }
2945                                 },
2946                                 _ => return Err(DecodeError::InvalidValue),
2947                         };
2948                         onchain_events_awaiting_threshold_conf.push(OnchainEventEntry { txid, height, event });
2949                 }
2950
2951                 let outputs_to_watch_len: u64 = Readable::read(reader)?;
2952                 let mut outputs_to_watch = HashMap::with_capacity(cmp::min(outputs_to_watch_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<Txid>() + mem::size_of::<u32>() + mem::size_of::<Vec<Script>>())));
2953                 for _ in 0..outputs_to_watch_len {
2954                         let txid = Readable::read(reader)?;
2955                         let outputs_len: u64 = Readable::read(reader)?;
2956                         let mut outputs = Vec::with_capacity(cmp::min(outputs_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<u32>() + mem::size_of::<Script>())));
2957                         for _ in 0..outputs_len {
2958                                 outputs.push((Readable::read(reader)?, Readable::read(reader)?));
2959                         }
2960                         if let Some(_) = outputs_to_watch.insert(txid, outputs) {
2961                                 return Err(DecodeError::InvalidValue);
2962                         }
2963                 }
2964                 let onchain_tx_handler = ReadableArgs::read(reader, keys_manager)?;
2965
2966                 let lockdown_from_offchain = Readable::read(reader)?;
2967                 let holder_tx_signed = Readable::read(reader)?;
2968
2969                 let mut secp_ctx = Secp256k1::new();
2970                 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
2971
2972                 Ok((best_block.block_hash(), ChannelMonitor {
2973                         inner: Mutex::new(ChannelMonitorImpl {
2974                                 latest_update_id,
2975                                 commitment_transaction_number_obscure_factor,
2976
2977                                 destination_script,
2978                                 broadcasted_holder_revokable_script,
2979                                 counterparty_payment_script,
2980                                 shutdown_script,
2981
2982                                 channel_keys_id,
2983                                 holder_revocation_basepoint,
2984                                 funding_info,
2985                                 current_counterparty_commitment_txid,
2986                                 prev_counterparty_commitment_txid,
2987
2988                                 counterparty_tx_cache,
2989                                 funding_redeemscript,
2990                                 channel_value_satoshis,
2991                                 their_cur_revocation_points,
2992
2993                                 on_holder_tx_csv,
2994
2995                                 commitment_secrets,
2996                                 counterparty_claimable_outpoints,
2997                                 counterparty_commitment_txn_on_chain,
2998                                 counterparty_hash_commitment_number,
2999
3000                                 prev_holder_signed_commitment_tx,
3001                                 current_holder_commitment_tx,
3002                                 current_counterparty_commitment_number,
3003                                 current_holder_commitment_number,
3004
3005                                 payment_preimages,
3006                                 pending_monitor_events,
3007                                 pending_events,
3008
3009                                 onchain_events_awaiting_threshold_conf,
3010                                 outputs_to_watch,
3011
3012                                 onchain_tx_handler,
3013
3014                                 lockdown_from_offchain,
3015                                 holder_tx_signed,
3016
3017                                 best_block,
3018
3019                                 secp_ctx,
3020                         }),
3021                 }))
3022         }
3023 }
3024
3025 #[cfg(test)]
3026 mod tests {
3027         use bitcoin::blockdata::script::{Script, Builder};
3028         use bitcoin::blockdata::opcodes;
3029         use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut, SigHashType};
3030         use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
3031         use bitcoin::util::bip143;
3032         use bitcoin::hashes::Hash;
3033         use bitcoin::hashes::sha256::Hash as Sha256;
3034         use bitcoin::hashes::hex::FromHex;
3035         use bitcoin::hash_types::Txid;
3036         use bitcoin::network::constants::Network;
3037         use hex;
3038         use chain::channelmonitor::ChannelMonitor;
3039         use chain::transaction::OutPoint;
3040         use ln::channelmanager::{BestBlock, PaymentPreimage, PaymentHash};
3041         use ln::onchaintx::{OnchainTxHandler, InputDescriptors};
3042         use ln::chan_utils;
3043         use ln::chan_utils::{HTLCOutputInCommitment, ChannelPublicKeys, ChannelTransactionParameters, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters};
3044         use util::test_utils::{TestLogger, TestBroadcaster, TestFeeEstimator};
3045         use bitcoin::secp256k1::key::{SecretKey,PublicKey};
3046         use bitcoin::secp256k1::Secp256k1;
3047         use std::sync::{Arc, Mutex};
3048         use chain::keysinterface::InMemorySigner;
3049
3050         #[test]
3051         fn test_prune_preimages() {
3052                 let secp_ctx = Secp256k1::new();
3053                 let logger = Arc::new(TestLogger::new());
3054                 let broadcaster = Arc::new(TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
3055                 let fee_estimator = Arc::new(TestFeeEstimator { sat_per_kw: 253 });
3056
3057                 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
3058                 let dummy_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
3059
3060                 let mut preimages = Vec::new();
3061                 {
3062                         for i in 0..20 {
3063                                 let preimage = PaymentPreimage([i; 32]);
3064                                 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
3065                                 preimages.push((preimage, hash));
3066                         }
3067                 }
3068
3069                 macro_rules! preimages_slice_to_htlc_outputs {
3070                         ($preimages_slice: expr) => {
3071                                 {
3072                                         let mut res = Vec::new();
3073                                         for (idx, preimage) in $preimages_slice.iter().enumerate() {
3074                                                 res.push((HTLCOutputInCommitment {
3075                                                         offered: true,
3076                                                         amount_msat: 0,
3077                                                         cltv_expiry: 0,
3078                                                         payment_hash: preimage.1.clone(),
3079                                                         transaction_output_index: Some(idx as u32),
3080                                                 }, None));
3081                                         }
3082                                         res
3083                                 }
3084                         }
3085                 }
3086                 macro_rules! preimages_to_holder_htlcs {
3087                         ($preimages_slice: expr) => {
3088                                 {
3089                                         let mut inp = preimages_slice_to_htlc_outputs!($preimages_slice);
3090                                         let res: Vec<_> = inp.drain(..).map(|e| { (e.0, None, e.1) }).collect();
3091                                         res
3092                                 }
3093                         }
3094                 }
3095
3096                 macro_rules! test_preimages_exist {
3097                         ($preimages_slice: expr, $monitor: expr) => {
3098                                 for preimage in $preimages_slice {
3099                                         assert!($monitor.inner.lock().unwrap().payment_preimages.contains_key(&preimage.1));
3100                                 }
3101                         }
3102                 }
3103
3104                 let keys = InMemorySigner::new(
3105                         &secp_ctx,
3106                         SecretKey::from_slice(&[41; 32]).unwrap(),
3107                         SecretKey::from_slice(&[41; 32]).unwrap(),
3108                         SecretKey::from_slice(&[41; 32]).unwrap(),
3109                         SecretKey::from_slice(&[41; 32]).unwrap(),
3110                         SecretKey::from_slice(&[41; 32]).unwrap(),
3111                         [41; 32],
3112                         0,
3113                         [0; 32]
3114                 );
3115
3116                 let counterparty_pubkeys = ChannelPublicKeys {
3117                         funding_pubkey: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[44; 32]).unwrap()),
3118                         revocation_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[45; 32]).unwrap()),
3119                         payment_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[46; 32]).unwrap()),
3120                         delayed_payment_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[47; 32]).unwrap()),
3121                         htlc_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[48; 32]).unwrap())
3122                 };
3123                 let funding_outpoint = OutPoint { txid: Default::default(), index: u16::max_value() };
3124                 let channel_parameters = ChannelTransactionParameters {
3125                         holder_pubkeys: keys.holder_channel_pubkeys.clone(),
3126                         holder_selected_contest_delay: 66,
3127                         is_outbound_from_holder: true,
3128                         counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
3129                                 pubkeys: counterparty_pubkeys,
3130                                 selected_contest_delay: 67,
3131                         }),
3132                         funding_outpoint: Some(funding_outpoint),
3133                 };
3134                 // Prune with one old state and a holder commitment tx holding a few overlaps with the
3135                 // old state.
3136                 let best_block = BestBlock::from_genesis(Network::Testnet);
3137                 let monitor = ChannelMonitor::new(Secp256k1::new(), keys,
3138                                                   &PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()), 0, &Script::new(),
3139                                                   (OutPoint { txid: Txid::from_slice(&[43; 32]).unwrap(), index: 0 }, Script::new()),
3140                                                   &channel_parameters,
3141                                                   Script::new(), 46, 0,
3142                                                   HolderCommitmentTransaction::dummy(), best_block);
3143
3144                 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..10])).unwrap();
3145                 let dummy_txid = dummy_tx.txid();
3146                 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[5..15]), 281474976710655, dummy_key, &logger);
3147                 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[15..20]), 281474976710654, dummy_key, &logger);
3148                 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[17..20]), 281474976710653, dummy_key, &logger);
3149                 monitor.provide_latest_counterparty_commitment_tx(dummy_txid, preimages_slice_to_htlc_outputs!(preimages[18..20]), 281474976710652, dummy_key, &logger);
3150                 for &(ref preimage, ref hash) in preimages.iter() {
3151                         monitor.provide_payment_preimage(hash, preimage, &broadcaster, &fee_estimator, &logger);
3152                 }
3153
3154                 // Now provide a secret, pruning preimages 10-15
3155                 let mut secret = [0; 32];
3156                 secret[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
3157                 monitor.provide_secret(281474976710655, secret.clone()).unwrap();
3158                 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 15);
3159                 test_preimages_exist!(&preimages[0..10], monitor);
3160                 test_preimages_exist!(&preimages[15..20], monitor);
3161
3162                 // Now provide a further secret, pruning preimages 15-17
3163                 secret[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
3164                 monitor.provide_secret(281474976710654, secret.clone()).unwrap();
3165                 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 13);
3166                 test_preimages_exist!(&preimages[0..10], monitor);
3167                 test_preimages_exist!(&preimages[17..20], monitor);
3168
3169                 // Now update holder commitment tx info, pruning only element 18 as we still care about the
3170                 // previous commitment tx's preimages too
3171                 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..5])).unwrap();
3172                 secret[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
3173                 monitor.provide_secret(281474976710653, secret.clone()).unwrap();
3174                 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 12);
3175                 test_preimages_exist!(&preimages[0..10], monitor);
3176                 test_preimages_exist!(&preimages[18..20], monitor);
3177
3178                 // But if we do it again, we'll prune 5-10
3179                 monitor.provide_latest_holder_commitment_tx(HolderCommitmentTransaction::dummy(), preimages_to_holder_htlcs!(preimages[0..3])).unwrap();
3180                 secret[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
3181                 monitor.provide_secret(281474976710652, secret.clone()).unwrap();
3182                 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 5);
3183                 test_preimages_exist!(&preimages[0..5], monitor);
3184         }
3185
3186         #[test]
3187         fn test_claim_txn_weight_computation() {
3188                 // We test Claim txn weight, knowing that we want expected weigth and
3189                 // not actual case to avoid sigs and time-lock delays hell variances.
3190
3191                 let secp_ctx = Secp256k1::new();
3192                 let privkey = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
3193                 let pubkey = PublicKey::from_secret_key(&secp_ctx, &privkey);
3194                 let mut sum_actual_sigs = 0;
3195
3196                 macro_rules! sign_input {
3197                         ($sighash_parts: expr, $idx: expr, $amount: expr, $input_type: expr, $sum_actual_sigs: expr) => {
3198                                 let htlc = HTLCOutputInCommitment {
3199                                         offered: if *$input_type == InputDescriptors::RevokedOfferedHTLC || *$input_type == InputDescriptors::OfferedHTLC { true } else { false },
3200                                         amount_msat: 0,
3201                                         cltv_expiry: 2 << 16,
3202                                         payment_hash: PaymentHash([1; 32]),
3203                                         transaction_output_index: Some($idx as u32),
3204                                 };
3205                                 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) };
3206                                 let sighash = hash_to_message!(&$sighash_parts.signature_hash($idx, &redeem_script, $amount, SigHashType::All)[..]);
3207                                 let sig = secp_ctx.sign(&sighash, &privkey);
3208                                 $sighash_parts.access_witness($idx).push(sig.serialize_der().to_vec());
3209                                 $sighash_parts.access_witness($idx)[0].push(SigHashType::All as u8);
3210                                 sum_actual_sigs += $sighash_parts.access_witness($idx)[0].len();
3211                                 if *$input_type == InputDescriptors::RevokedOutput {
3212                                         $sighash_parts.access_witness($idx).push(vec!(1));
3213                                 } else if *$input_type == InputDescriptors::RevokedOfferedHTLC || *$input_type == InputDescriptors::RevokedReceivedHTLC {
3214                                         $sighash_parts.access_witness($idx).push(pubkey.clone().serialize().to_vec());
3215                                 } else if *$input_type == InputDescriptors::ReceivedHTLC {
3216                                         $sighash_parts.access_witness($idx).push(vec![0]);
3217                                 } else {
3218                                         $sighash_parts.access_witness($idx).push(PaymentPreimage([1; 32]).0.to_vec());
3219                                 }
3220                                 $sighash_parts.access_witness($idx).push(redeem_script.into_bytes());
3221                                 println!("witness[0] {}", $sighash_parts.access_witness($idx)[0].len());
3222                                 println!("witness[1] {}", $sighash_parts.access_witness($idx)[1].len());
3223                                 println!("witness[2] {}", $sighash_parts.access_witness($idx)[2].len());
3224                         }
3225                 }
3226
3227                 let script_pubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script();
3228                 let txid = Txid::from_hex("56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d").unwrap();
3229
3230                 // Justice tx with 1 to_holder, 2 revoked offered HTLCs, 1 revoked received HTLCs
3231                 let mut claim_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
3232                 for i in 0..4 {
3233                         claim_tx.input.push(TxIn {
3234                                 previous_output: BitcoinOutPoint {
3235                                         txid,
3236                                         vout: i,
3237                                 },
3238                                 script_sig: Script::new(),
3239                                 sequence: 0xfffffffd,
3240                                 witness: Vec::new(),
3241                         });
3242                 }
3243                 claim_tx.output.push(TxOut {
3244                         script_pubkey: script_pubkey.clone(),
3245                         value: 0,
3246                 });
3247                 let base_weight = claim_tx.get_weight();
3248                 let inputs_des = vec![InputDescriptors::RevokedOutput, InputDescriptors::RevokedOfferedHTLC, InputDescriptors::RevokedOfferedHTLC, InputDescriptors::RevokedReceivedHTLC];
3249                 {
3250                         let mut sighash_parts = bip143::SigHashCache::new(&mut claim_tx);
3251                         for (idx, inp) in inputs_des.iter().enumerate() {
3252                                 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs);
3253                         }
3254                 }
3255                 assert_eq!(base_weight + OnchainTxHandler::<InMemorySigner>::get_witnesses_weight(&inputs_des[..]),  claim_tx.get_weight() + /* max_length_sig */ (73 * inputs_des.len() - sum_actual_sigs));
3256
3257                 // Claim tx with 1 offered HTLCs, 3 received HTLCs
3258                 claim_tx.input.clear();
3259                 sum_actual_sigs = 0;
3260                 for i in 0..4 {
3261                         claim_tx.input.push(TxIn {
3262                                 previous_output: BitcoinOutPoint {
3263                                         txid,
3264                                         vout: i,
3265                                 },
3266                                 script_sig: Script::new(),
3267                                 sequence: 0xfffffffd,
3268                                 witness: Vec::new(),
3269                         });
3270                 }
3271                 let base_weight = claim_tx.get_weight();
3272                 let inputs_des = vec![InputDescriptors::OfferedHTLC, InputDescriptors::ReceivedHTLC, InputDescriptors::ReceivedHTLC, InputDescriptors::ReceivedHTLC];
3273                 {
3274                         let mut sighash_parts = bip143::SigHashCache::new(&mut claim_tx);
3275                         for (idx, inp) in inputs_des.iter().enumerate() {
3276                                 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs);
3277                         }
3278                 }
3279                 assert_eq!(base_weight + OnchainTxHandler::<InMemorySigner>::get_witnesses_weight(&inputs_des[..]),  claim_tx.get_weight() + /* max_length_sig */ (73 * inputs_des.len() - sum_actual_sigs));
3280
3281                 // Justice tx with 1 revoked HTLC-Success tx output
3282                 claim_tx.input.clear();
3283                 sum_actual_sigs = 0;
3284                 claim_tx.input.push(TxIn {
3285                         previous_output: BitcoinOutPoint {
3286                                 txid,
3287                                 vout: 0,
3288                         },
3289                         script_sig: Script::new(),
3290                         sequence: 0xfffffffd,
3291                         witness: Vec::new(),
3292                 });
3293                 let base_weight = claim_tx.get_weight();
3294                 let inputs_des = vec![InputDescriptors::RevokedOutput];
3295                 {
3296                         let mut sighash_parts = bip143::SigHashCache::new(&mut claim_tx);
3297                         for (idx, inp) in inputs_des.iter().enumerate() {
3298                                 sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs);
3299                         }
3300                 }
3301                 assert_eq!(base_weight + OnchainTxHandler::<InMemorySigner>::get_witnesses_weight(&inputs_des[..]), claim_tx.get_weight() + /* max_length_isg */ (73 * inputs_des.len() - sum_actual_sigs));
3302         }
3303
3304         // Further testing is done in the ChannelManager integration tests.
3305 }