Update docs on `MonitorEvent::HolderForceClosed`
[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::BlockHeader;
24 use bitcoin::blockdata::transaction::{OutPoint as BitcoinOutPoint, TxOut, Transaction};
25 use bitcoin::blockdata::script::Script;
26
27 use bitcoin::hashes::Hash;
28 use bitcoin::hashes::sha256::Hash as Sha256;
29 use bitcoin::hash_types::{Txid, BlockHash};
30
31 use bitcoin::secp256k1::{Secp256k1, ecdsa::Signature};
32 use bitcoin::secp256k1::{SecretKey, PublicKey};
33 use bitcoin::{secp256k1, EcdsaSighashType};
34
35 use crate::ln::channel::INITIAL_COMMITMENT_NUMBER;
36 use crate::ln::{PaymentHash, PaymentPreimage};
37 use crate::ln::msgs::DecodeError;
38 use crate::ln::chan_utils;
39 use crate::ln::chan_utils::{CommitmentTransaction, CounterpartyCommitmentSecrets, HTLCOutputInCommitment, HTLCClaim, ChannelTransactionParameters, HolderCommitmentTransaction, TxCreationKeys};
40 use crate::ln::channelmanager::{HTLCSource, SentHTLCId};
41 use crate::chain;
42 use crate::chain::{BestBlock, WatchedOutput};
43 use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator, LowerBoundedFeeEstimator};
44 use crate::chain::transaction::{OutPoint, TransactionData};
45 use crate::sign::{SpendableOutputDescriptor, StaticPaymentOutputDescriptor, DelayedPaymentOutputDescriptor, WriteableEcdsaChannelSigner, SignerProvider, EntropySource};
46 use crate::chain::onchaintx::{ClaimEvent, OnchainTxHandler};
47 use crate::chain::package::{CounterpartyOfferedHTLCOutput, CounterpartyReceivedHTLCOutput, HolderFundingOutput, HolderHTLCOutput, PackageSolvingData, PackageTemplate, RevokedOutput, RevokedHTLCOutput};
48 use crate::chain::Filter;
49 use crate::util::logger::Logger;
50 use crate::util::ser::{Readable, ReadableArgs, RequiredWrapper, MaybeReadable, UpgradableRequired, Writer, Writeable, U48};
51 use crate::util::byte_utils;
52 use crate::events::{Event, EventHandler};
53 use crate::events::bump_transaction::{ChannelDerivationParameters, AnchorDescriptor, HTLCDescriptor, BumpTransactionEvent};
54
55 use crate::prelude::*;
56 use core::{cmp, mem};
57 use crate::io::{self, Error};
58 use core::convert::TryInto;
59 use core::ops::Deref;
60 use crate::sync::{Mutex, LockTestExt};
61
62 /// An update generated by the underlying channel itself which contains some new information the
63 /// [`ChannelMonitor`] should be made aware of.
64 ///
65 /// Because this represents only a small number of updates to the underlying state, it is generally
66 /// much smaller than a full [`ChannelMonitor`]. However, for large single commitment transaction
67 /// updates (e.g. ones during which there are hundreds of HTLCs pending on the commitment
68 /// transaction), a single update may reach upwards of 1 MiB in serialized size.
69 #[derive(Clone, Debug, PartialEq, Eq)]
70 #[must_use]
71 pub struct ChannelMonitorUpdate {
72         pub(crate) updates: Vec<ChannelMonitorUpdateStep>,
73         /// The sequence number of this update. Updates *must* be replayed in-order according to this
74         /// sequence number (and updates may panic if they are not). The update_id values are strictly
75         /// increasing and increase by one for each new update, with two exceptions specified below.
76         ///
77         /// This sequence number is also used to track up to which points updates which returned
78         /// [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given
79         /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
80         ///
81         /// The only instances we allow where update_id values are not strictly increasing have a
82         /// special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. This update ID is used for updates that
83         /// will force close the channel by broadcasting the latest commitment transaction or
84         /// special post-force-close updates, like providing preimages necessary to claim outputs on the
85         /// broadcast commitment transaction. See its docs for more details.
86         ///
87         /// [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
88         pub update_id: u64,
89 }
90
91 /// The update ID used for a [`ChannelMonitorUpdate`] that is either:
92 ///
93 ///     (1) attempting to force close the channel by broadcasting our latest commitment transaction or
94 ///     (2) providing a preimage (after the channel has been force closed) from a forward link that
95 ///             allows us to spend an HTLC output on this channel's (the backward link's) broadcasted
96 ///             commitment transaction.
97 ///
98 /// No other [`ChannelMonitorUpdate`]s are allowed after force-close.
99 pub const CLOSED_CHANNEL_UPDATE_ID: u64 = core::u64::MAX;
100
101 impl Writeable for ChannelMonitorUpdate {
102         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
103                 write_ver_prefix!(w, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
104                 self.update_id.write(w)?;
105                 (self.updates.len() as u64).write(w)?;
106                 for update_step in self.updates.iter() {
107                         update_step.write(w)?;
108                 }
109                 write_tlv_fields!(w, {});
110                 Ok(())
111         }
112 }
113 impl Readable for ChannelMonitorUpdate {
114         fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
115                 let _ver = read_ver_prefix!(r, SERIALIZATION_VERSION);
116                 let update_id: u64 = Readable::read(r)?;
117                 let len: u64 = Readable::read(r)?;
118                 let mut updates = Vec::with_capacity(cmp::min(len as usize, MAX_ALLOC_SIZE / ::core::mem::size_of::<ChannelMonitorUpdateStep>()));
119                 for _ in 0..len {
120                         if let Some(upd) = MaybeReadable::read(r)? {
121                                 updates.push(upd);
122                         }
123                 }
124                 read_tlv_fields!(r, {});
125                 Ok(Self { update_id, updates })
126         }
127 }
128
129 /// An event to be processed by the ChannelManager.
130 #[derive(Clone, PartialEq, Eq)]
131 pub enum MonitorEvent {
132         /// A monitor event containing an HTLCUpdate.
133         HTLCEvent(HTLCUpdate),
134
135         /// Indicates we broadcasted the channel's latest commitment transaction and thus closed the
136         /// channel.
137         HolderForceClosed(OutPoint),
138
139         /// Indicates a [`ChannelMonitor`] update has completed. See
140         /// [`ChannelMonitorUpdateStatus::InProgress`] for more information on how this is used.
141         ///
142         /// [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
143         Completed {
144                 /// The funding outpoint of the [`ChannelMonitor`] that was updated
145                 funding_txo: OutPoint,
146                 /// The Update ID from [`ChannelMonitorUpdate::update_id`] which was applied or
147                 /// [`ChannelMonitor::get_latest_update_id`].
148                 ///
149                 /// Note that this should only be set to a given update's ID if all previous updates for the
150                 /// same [`ChannelMonitor`] have been applied and persisted.
151                 monitor_update_id: u64,
152         },
153 }
154 impl_writeable_tlv_based_enum_upgradable!(MonitorEvent,
155         // Note that Completed is currently never serialized to disk as it is generated only in
156         // ChainMonitor.
157         (0, Completed) => {
158                 (0, funding_txo, required),
159                 (2, monitor_update_id, required),
160         },
161 ;
162         (2, HTLCEvent),
163         (4, HolderForceClosed),
164         // 6 was `UpdateFailed` until LDK 0.0.117
165 );
166
167 /// Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
168 /// chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
169 /// preimage claim backward will lead to loss of funds.
170 #[derive(Clone, PartialEq, Eq)]
171 pub struct HTLCUpdate {
172         pub(crate) payment_hash: PaymentHash,
173         pub(crate) payment_preimage: Option<PaymentPreimage>,
174         pub(crate) source: HTLCSource,
175         pub(crate) htlc_value_satoshis: Option<u64>,
176 }
177 impl_writeable_tlv_based!(HTLCUpdate, {
178         (0, payment_hash, required),
179         (1, htlc_value_satoshis, option),
180         (2, source, required),
181         (4, payment_preimage, option),
182 });
183
184 /// If an HTLC expires within this many blocks, don't try to claim it in a shared transaction,
185 /// instead claiming it in its own individual transaction.
186 pub(crate) const CLTV_SHARED_CLAIM_BUFFER: u32 = 12;
187 /// If an HTLC expires within this many blocks, force-close the channel to broadcast the
188 /// HTLC-Success transaction.
189 /// In other words, this is an upper bound on how many blocks we think it can take us to get a
190 /// transaction confirmed (and we use it in a few more, equivalent, places).
191 pub(crate) const CLTV_CLAIM_BUFFER: u32 = 18;
192 /// Number of blocks by which point we expect our counterparty to have seen new blocks on the
193 /// network and done a full update_fail_htlc/commitment_signed dance (+ we've updated all our
194 /// copies of ChannelMonitors, including watchtowers). We could enforce the contract by failing
195 /// at CLTV expiration height but giving a grace period to our peer may be profitable for us if he
196 /// can provide an over-late preimage. Nevertheless, grace period has to be accounted in our
197 /// CLTV_EXPIRY_DELTA to be secure. Following this policy we may decrease the rate of channel failures
198 /// due to expiration but increase the cost of funds being locked longuer in case of failure.
199 /// This delay also cover a low-power peer being slow to process blocks and so being behind us on
200 /// accurate block height.
201 /// In case of onchain failure to be pass backward we may see the last block of ANTI_REORG_DELAY
202 /// with at worst this delay, so we are not only using this value as a mercy for them but also
203 /// us as a safeguard to delay with enough time.
204 pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
205 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding
206 /// inbound HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us
207 /// losing money.
208 ///
209 /// Note that this is a library-wide security assumption. If a reorg deeper than this number of
210 /// blocks occurs, counterparties may be able to steal funds or claims made by and balances exposed
211 /// by a  [`ChannelMonitor`] may be incorrect.
212 // We also use this delay to be sure we can remove our in-flight claim txn from bump candidates buffer.
213 // It may cause spurious generation of bumped claim txn but that's alright given the outpoint is already
214 // solved by a previous claim tx. What we want to avoid is reorg evicting our claim tx and us not
215 // keep bumping another claim tx to solve the outpoint.
216 pub const ANTI_REORG_DELAY: u32 = 6;
217 /// Number of blocks before confirmation at which we fail back an un-relayed HTLC or at which we
218 /// refuse to accept a new HTLC.
219 ///
220 /// This is used for a few separate purposes:
221 /// 1) if we've received an MPP HTLC to us and it expires within this many blocks and we are
222 ///    waiting on additional parts (or waiting on the preimage for any HTLC from the user), we will
223 ///    fail this HTLC,
224 /// 2) if we receive an HTLC within this many blocks of its expiry (plus one to avoid a race
225 ///    condition with the above), we will fail this HTLC without telling the user we received it,
226 ///
227 /// (1) is all about protecting us - we need enough time to update the channel state before we hit
228 /// CLTV_CLAIM_BUFFER, at which point we'd go on chain to claim the HTLC with the preimage.
229 ///
230 /// (2) is the same, but with an additional buffer to avoid accepting an HTLC which is immediately
231 /// in a race condition between the user connecting a block (which would fail it) and the user
232 /// providing us the preimage (which would claim it).
233 pub(crate) const HTLC_FAIL_BACK_BUFFER: u32 = CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS;
234
235 // TODO(devrandom) replace this with HolderCommitmentTransaction
236 #[derive(Clone, PartialEq, Eq)]
237 struct HolderSignedTx {
238         /// txid of the transaction in tx, just used to make comparison faster
239         txid: Txid,
240         revocation_key: PublicKey,
241         a_htlc_key: PublicKey,
242         b_htlc_key: PublicKey,
243         delayed_payment_key: PublicKey,
244         per_commitment_point: PublicKey,
245         htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
246         to_self_value_sat: u64,
247         feerate_per_kw: u32,
248 }
249 impl_writeable_tlv_based!(HolderSignedTx, {
250         (0, txid, required),
251         // Note that this is filled in with data from OnchainTxHandler if it's missing.
252         // For HolderSignedTx objects serialized with 0.0.100+, this should be filled in.
253         (1, to_self_value_sat, (default_value, u64::max_value())),
254         (2, revocation_key, required),
255         (4, a_htlc_key, required),
256         (6, b_htlc_key, required),
257         (8, delayed_payment_key, required),
258         (10, per_commitment_point, required),
259         (12, feerate_per_kw, required),
260         (14, htlc_outputs, required_vec)
261 });
262
263 impl HolderSignedTx {
264         fn non_dust_htlcs(&self) -> Vec<HTLCOutputInCommitment> {
265                 self.htlc_outputs.iter().filter_map(|(htlc, _, _)| {
266                         if let Some(_) = htlc.transaction_output_index {
267                                 Some(htlc.clone())
268                         } else {
269                                 None
270                         }
271                 })
272                 .collect()
273         }
274 }
275
276 /// We use this to track static counterparty commitment transaction data and to generate any
277 /// justice or 2nd-stage preimage/timeout transactions.
278 #[derive(Clone, PartialEq, Eq)]
279 struct CounterpartyCommitmentParameters {
280         counterparty_delayed_payment_base_key: PublicKey,
281         counterparty_htlc_base_key: PublicKey,
282         on_counterparty_tx_csv: u16,
283 }
284
285 impl Writeable for CounterpartyCommitmentParameters {
286         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
287                 w.write_all(&(0 as u64).to_be_bytes())?;
288                 write_tlv_fields!(w, {
289                         (0, self.counterparty_delayed_payment_base_key, required),
290                         (2, self.counterparty_htlc_base_key, required),
291                         (4, self.on_counterparty_tx_csv, required),
292                 });
293                 Ok(())
294         }
295 }
296 impl Readable for CounterpartyCommitmentParameters {
297         fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
298                 let counterparty_commitment_transaction = {
299                         // Versions prior to 0.0.100 had some per-HTLC state stored here, which is no longer
300                         // used. Read it for compatibility.
301                         let per_htlc_len: u64 = Readable::read(r)?;
302                         for _  in 0..per_htlc_len {
303                                 let _txid: Txid = Readable::read(r)?;
304                                 let htlcs_count: u64 = Readable::read(r)?;
305                                 for _ in 0..htlcs_count {
306                                         let _htlc: HTLCOutputInCommitment = Readable::read(r)?;
307                                 }
308                         }
309
310                         let mut counterparty_delayed_payment_base_key = RequiredWrapper(None);
311                         let mut counterparty_htlc_base_key = RequiredWrapper(None);
312                         let mut on_counterparty_tx_csv: u16 = 0;
313                         read_tlv_fields!(r, {
314                                 (0, counterparty_delayed_payment_base_key, required),
315                                 (2, counterparty_htlc_base_key, required),
316                                 (4, on_counterparty_tx_csv, required),
317                         });
318                         CounterpartyCommitmentParameters {
319                                 counterparty_delayed_payment_base_key: counterparty_delayed_payment_base_key.0.unwrap(),
320                                 counterparty_htlc_base_key: counterparty_htlc_base_key.0.unwrap(),
321                                 on_counterparty_tx_csv,
322                         }
323                 };
324                 Ok(counterparty_commitment_transaction)
325         }
326 }
327
328 /// An entry for an [`OnchainEvent`], stating the block height and hash when the event was
329 /// observed, as well as the transaction causing it.
330 ///
331 /// Used to determine when the on-chain event can be considered safe from a chain reorganization.
332 #[derive(Clone, PartialEq, Eq)]
333 struct OnchainEventEntry {
334         txid: Txid,
335         height: u32,
336         block_hash: Option<BlockHash>, // Added as optional, will be filled in for any entry generated on 0.0.113 or after
337         event: OnchainEvent,
338         transaction: Option<Transaction>, // Added as optional, but always filled in, in LDK 0.0.110
339 }
340
341 impl OnchainEventEntry {
342         fn confirmation_threshold(&self) -> u32 {
343                 let mut conf_threshold = self.height + ANTI_REORG_DELAY - 1;
344                 match self.event {
345                         OnchainEvent::MaturingOutput {
346                                 descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor)
347                         } => {
348                                 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
349                                 // it's broadcastable when we see the previous block.
350                                 conf_threshold = cmp::max(conf_threshold, self.height + descriptor.to_self_delay as u32 - 1);
351                         },
352                         OnchainEvent::FundingSpendConfirmation { on_local_output_csv: Some(csv), .. } |
353                         OnchainEvent::HTLCSpendConfirmation { on_to_local_output_csv: Some(csv), .. } => {
354                                 // A CSV'd transaction is confirmable in block (input height) + CSV delay, which means
355                                 // it's broadcastable when we see the previous block.
356                                 conf_threshold = cmp::max(conf_threshold, self.height + csv as u32 - 1);
357                         },
358                         _ => {},
359                 }
360                 conf_threshold
361         }
362
363         fn has_reached_confirmation_threshold(&self, best_block: &BestBlock) -> bool {
364                 best_block.height() >= self.confirmation_threshold()
365         }
366 }
367
368 /// The (output index, sats value) for the counterparty's output in a commitment transaction.
369 ///
370 /// This was added as an `Option` in 0.0.110.
371 type CommitmentTxCounterpartyOutputInfo = Option<(u32, u64)>;
372
373 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
374 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
375 #[derive(Clone, PartialEq, Eq)]
376 enum OnchainEvent {
377         /// An outbound HTLC failing after a transaction is confirmed. Used
378         ///  * when an outbound HTLC output is spent by us after the HTLC timed out
379         ///  * an outbound HTLC which was not present in the commitment transaction which appeared
380         ///    on-chain (either because it was not fully committed to or it was dust).
381         /// Note that this is *not* used for preimage claims, as those are passed upstream immediately,
382         /// appearing only as an `HTLCSpendConfirmation`, below.
383         HTLCUpdate {
384                 source: HTLCSource,
385                 payment_hash: PaymentHash,
386                 htlc_value_satoshis: Option<u64>,
387                 /// None in the second case, above, ie when there is no relevant output in the commitment
388                 /// transaction which appeared on chain.
389                 commitment_tx_output_idx: Option<u32>,
390         },
391         /// An output waiting on [`ANTI_REORG_DELAY`] confirmations before we hand the user the
392         /// [`SpendableOutputDescriptor`].
393         MaturingOutput {
394                 descriptor: SpendableOutputDescriptor,
395         },
396         /// A spend of the funding output, either a commitment transaction or a cooperative closing
397         /// transaction.
398         FundingSpendConfirmation {
399                 /// The CSV delay for the output of the funding spend transaction (implying it is a local
400                 /// commitment transaction, and this is the delay on the to_self output).
401                 on_local_output_csv: Option<u16>,
402                 /// If the funding spend transaction was a known remote commitment transaction, we track
403                 /// the output index and amount of the counterparty's `to_self` output here.
404                 ///
405                 /// This allows us to generate a [`Balance::CounterpartyRevokedOutputClaimable`] for the
406                 /// counterparty output.
407                 commitment_tx_to_counterparty_output: CommitmentTxCounterpartyOutputInfo,
408         },
409         /// A spend of a commitment transaction HTLC output, set in the cases where *no* `HTLCUpdate`
410         /// is constructed. This is used when
411         ///  * an outbound HTLC is claimed by our counterparty with a preimage, causing us to
412         ///    immediately claim the HTLC on the inbound edge and track the resolution here,
413         ///  * an inbound HTLC is claimed by our counterparty (with a timeout),
414         ///  * an inbound HTLC is claimed by us (with a preimage).
415         ///  * a revoked-state HTLC transaction was broadcasted, which was claimed by the revocation
416         ///    signature.
417         ///  * a revoked-state HTLC transaction was broadcasted, which was claimed by an
418         ///    HTLC-Success/HTLC-Failure transaction (and is still claimable with a revocation
419         ///    signature).
420         HTLCSpendConfirmation {
421                 commitment_tx_output_idx: u32,
422                 /// If the claim was made by either party with a preimage, this is filled in
423                 preimage: Option<PaymentPreimage>,
424                 /// If the claim was made by us on an inbound HTLC against a local commitment transaction,
425                 /// we set this to the output CSV value which we will have to wait until to spend the
426                 /// output (and generate a SpendableOutput event).
427                 on_to_local_output_csv: Option<u16>,
428         },
429 }
430
431 impl Writeable for OnchainEventEntry {
432         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
433                 write_tlv_fields!(writer, {
434                         (0, self.txid, required),
435                         (1, self.transaction, option),
436                         (2, self.height, required),
437                         (3, self.block_hash, option),
438                         (4, self.event, required),
439                 });
440                 Ok(())
441         }
442 }
443
444 impl MaybeReadable for OnchainEventEntry {
445         fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, DecodeError> {
446                 let mut txid = Txid::all_zeros();
447                 let mut transaction = None;
448                 let mut block_hash = None;
449                 let mut height = 0;
450                 let mut event = UpgradableRequired(None);
451                 read_tlv_fields!(reader, {
452                         (0, txid, required),
453                         (1, transaction, option),
454                         (2, height, required),
455                         (3, block_hash, option),
456                         (4, event, upgradable_required),
457                 });
458                 Ok(Some(Self { txid, transaction, height, block_hash, event: _init_tlv_based_struct_field!(event, upgradable_required) }))
459         }
460 }
461
462 impl_writeable_tlv_based_enum_upgradable!(OnchainEvent,
463         (0, HTLCUpdate) => {
464                 (0, source, required),
465                 (1, htlc_value_satoshis, option),
466                 (2, payment_hash, required),
467                 (3, commitment_tx_output_idx, option),
468         },
469         (1, MaturingOutput) => {
470                 (0, descriptor, required),
471         },
472         (3, FundingSpendConfirmation) => {
473                 (0, on_local_output_csv, option),
474                 (1, commitment_tx_to_counterparty_output, option),
475         },
476         (5, HTLCSpendConfirmation) => {
477                 (0, commitment_tx_output_idx, required),
478                 (2, preimage, option),
479                 (4, on_to_local_output_csv, option),
480         },
481
482 );
483
484 #[derive(Clone, Debug, PartialEq, Eq)]
485 pub(crate) enum ChannelMonitorUpdateStep {
486         LatestHolderCommitmentTXInfo {
487                 commitment_tx: HolderCommitmentTransaction,
488                 /// Note that LDK after 0.0.115 supports this only containing dust HTLCs (implying the
489                 /// `Signature` field is never filled in). At that point, non-dust HTLCs are implied by the
490                 /// HTLC fields in `commitment_tx` and the sources passed via `nondust_htlc_sources`.
491                 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
492                 claimed_htlcs: Vec<(SentHTLCId, PaymentPreimage)>,
493                 nondust_htlc_sources: Vec<HTLCSource>,
494         },
495         LatestCounterpartyCommitmentTXInfo {
496                 commitment_txid: Txid,
497                 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
498                 commitment_number: u64,
499                 their_per_commitment_point: PublicKey,
500                 feerate_per_kw: Option<u32>,
501                 to_broadcaster_value_sat: Option<u64>,
502                 to_countersignatory_value_sat: Option<u64>,
503         },
504         PaymentPreimage {
505                 payment_preimage: PaymentPreimage,
506         },
507         CommitmentSecret {
508                 idx: u64,
509                 secret: [u8; 32],
510         },
511         /// Used to indicate that the no future updates will occur, and likely that the latest holder
512         /// commitment transaction(s) should be broadcast, as the channel has been force-closed.
513         ChannelForceClosed {
514                 /// If set to false, we shouldn't broadcast the latest holder commitment transaction as we
515                 /// think we've fallen behind!
516                 should_broadcast: bool,
517         },
518         ShutdownScript {
519                 scriptpubkey: Script,
520         },
521 }
522
523 impl ChannelMonitorUpdateStep {
524         fn variant_name(&self) -> &'static str {
525                 match self {
526                         ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { .. } => "LatestHolderCommitmentTXInfo",
527                         ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { .. } => "LatestCounterpartyCommitmentTXInfo",
528                         ChannelMonitorUpdateStep::PaymentPreimage { .. } => "PaymentPreimage",
529                         ChannelMonitorUpdateStep::CommitmentSecret { .. } => "CommitmentSecret",
530                         ChannelMonitorUpdateStep::ChannelForceClosed { .. } => "ChannelForceClosed",
531                         ChannelMonitorUpdateStep::ShutdownScript { .. } => "ShutdownScript",
532                 }
533         }
534 }
535
536 impl_writeable_tlv_based_enum_upgradable!(ChannelMonitorUpdateStep,
537         (0, LatestHolderCommitmentTXInfo) => {
538                 (0, commitment_tx, required),
539                 (1, claimed_htlcs, optional_vec),
540                 (2, htlc_outputs, required_vec),
541                 (4, nondust_htlc_sources, optional_vec),
542         },
543         (1, LatestCounterpartyCommitmentTXInfo) => {
544                 (0, commitment_txid, required),
545                 (1, feerate_per_kw, option),
546                 (2, commitment_number, required),
547                 (3, to_broadcaster_value_sat, option),
548                 (4, their_per_commitment_point, required),
549                 (5, to_countersignatory_value_sat, option),
550                 (6, htlc_outputs, required_vec),
551         },
552         (2, PaymentPreimage) => {
553                 (0, payment_preimage, required),
554         },
555         (3, CommitmentSecret) => {
556                 (0, idx, required),
557                 (2, secret, required),
558         },
559         (4, ChannelForceClosed) => {
560                 (0, should_broadcast, required),
561         },
562         (5, ShutdownScript) => {
563                 (0, scriptpubkey, required),
564         },
565 );
566
567 /// Details about the balance(s) available for spending once the channel appears on chain.
568 ///
569 /// See [`ChannelMonitor::get_claimable_balances`] for more details on when these will or will not
570 /// be provided.
571 #[derive(Clone, Debug, PartialEq, Eq)]
572 #[cfg_attr(test, derive(PartialOrd, Ord))]
573 pub enum Balance {
574         /// The channel is not yet closed (or the commitment or closing transaction has not yet
575         /// appeared in a block). The given balance is claimable (less on-chain fees) if the channel is
576         /// force-closed now.
577         ClaimableOnChannelClose {
578                 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
579                 /// required to do so.
580                 amount_satoshis: u64,
581         },
582         /// The channel has been closed, and the given balance is ours but awaiting confirmations until
583         /// we consider it spendable.
584         ClaimableAwaitingConfirmations {
585                 /// The amount available to claim, in satoshis, possibly excluding the on-chain fees which
586                 /// were spent in broadcasting the transaction.
587                 amount_satoshis: u64,
588                 /// The height at which an [`Event::SpendableOutputs`] event will be generated for this
589                 /// amount.
590                 confirmation_height: u32,
591         },
592         /// The channel has been closed, and the given balance should be ours but awaiting spending
593         /// transaction confirmation. If the spending transaction does not confirm in time, it is
594         /// possible our counterparty can take the funds by broadcasting an HTLC timeout on-chain.
595         ///
596         /// Once the spending transaction confirms, before it has reached enough confirmations to be
597         /// considered safe from chain reorganizations, the balance will instead be provided via
598         /// [`Balance::ClaimableAwaitingConfirmations`].
599         ContentiousClaimable {
600                 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
601                 /// required to do so.
602                 amount_satoshis: u64,
603                 /// The height at which the counterparty may be able to claim the balance if we have not
604                 /// done so.
605                 timeout_height: u32,
606                 /// The payment hash that locks this HTLC.
607                 payment_hash: PaymentHash,
608                 /// The preimage that can be used to claim this HTLC.
609                 payment_preimage: PaymentPreimage,
610         },
611         /// HTLCs which we sent to our counterparty which are claimable after a timeout (less on-chain
612         /// fees) if the counterparty does not know the preimage for the HTLCs. These are somewhat
613         /// likely to be claimed by our counterparty before we do.
614         MaybeTimeoutClaimableHTLC {
615                 /// The amount potentially available to claim, in satoshis, excluding the on-chain fees
616                 /// which will be required to do so.
617                 amount_satoshis: u64,
618                 /// The height at which we will be able to claim the balance if our counterparty has not
619                 /// done so.
620                 claimable_height: u32,
621                 /// The payment hash whose preimage our counterparty needs to claim this HTLC.
622                 payment_hash: PaymentHash,
623         },
624         /// HTLCs which we received from our counterparty which are claimable with a preimage which we
625         /// do not currently have. This will only be claimable if we receive the preimage from the node
626         /// to which we forwarded this HTLC before the timeout.
627         MaybePreimageClaimableHTLC {
628                 /// The amount potentially available to claim, in satoshis, excluding the on-chain fees
629                 /// which will be required to do so.
630                 amount_satoshis: u64,
631                 /// The height at which our counterparty will be able to claim the balance if we have not
632                 /// yet received the preimage and claimed it ourselves.
633                 expiry_height: u32,
634                 /// The payment hash whose preimage we need to claim this HTLC.
635                 payment_hash: PaymentHash,
636         },
637         /// The channel has been closed, and our counterparty broadcasted a revoked commitment
638         /// transaction.
639         ///
640         /// Thus, we're able to claim all outputs in the commitment transaction, one of which has the
641         /// following amount.
642         CounterpartyRevokedOutputClaimable {
643                 /// The amount, in satoshis, of the output which we can claim.
644                 ///
645                 /// Note that for outputs from HTLC balances this may be excluding some on-chain fees that
646                 /// were already spent.
647                 amount_satoshis: u64,
648         },
649 }
650
651 impl Balance {
652         /// The amount claimable, in satoshis. This excludes balances that we are unsure if we are able
653         /// to claim, this is because we are waiting for a preimage or for a timeout to expire. For more
654         /// information on these balances see [`Balance::MaybeTimeoutClaimableHTLC`] and
655         /// [`Balance::MaybePreimageClaimableHTLC`].
656         ///
657         /// On-chain fees required to claim the balance are not included in this amount.
658         pub fn claimable_amount_satoshis(&self) -> u64 {
659                 match self {
660                         Balance::ClaimableOnChannelClose { amount_satoshis, .. }|
661                         Balance::ClaimableAwaitingConfirmations { amount_satoshis, .. }|
662                         Balance::ContentiousClaimable { amount_satoshis, .. }|
663                         Balance::CounterpartyRevokedOutputClaimable { amount_satoshis, .. }
664                                 => *amount_satoshis,
665                         Balance::MaybeTimeoutClaimableHTLC { .. }|
666                         Balance::MaybePreimageClaimableHTLC { .. }
667                                 => 0,
668                 }
669         }
670 }
671
672 /// An HTLC which has been irrevocably resolved on-chain, and has reached ANTI_REORG_DELAY.
673 #[derive(Clone, PartialEq, Eq)]
674 struct IrrevocablyResolvedHTLC {
675         commitment_tx_output_idx: Option<u32>,
676         /// The txid of the transaction which resolved the HTLC, this may be a commitment (if the HTLC
677         /// was not present in the confirmed commitment transaction), HTLC-Success, or HTLC-Timeout
678         /// transaction.
679         resolving_txid: Option<Txid>, // Added as optional, but always filled in, in 0.0.110
680         resolving_tx: Option<Transaction>,
681         /// Only set if the HTLC claim was ours using a payment preimage
682         payment_preimage: Option<PaymentPreimage>,
683 }
684
685 // In LDK versions prior to 0.0.111 commitment_tx_output_idx was not Option-al and
686 // IrrevocablyResolvedHTLC objects only existed for non-dust HTLCs. This was a bug, but to maintain
687 // backwards compatibility we must ensure we always write out a commitment_tx_output_idx field,
688 // using `u32::max_value()` as a sentinal to indicate the HTLC was dust.
689 impl Writeable for IrrevocablyResolvedHTLC {
690         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
691                 let mapped_commitment_tx_output_idx = self.commitment_tx_output_idx.unwrap_or(u32::max_value());
692                 write_tlv_fields!(writer, {
693                         (0, mapped_commitment_tx_output_idx, required),
694                         (1, self.resolving_txid, option),
695                         (2, self.payment_preimage, option),
696                         (3, self.resolving_tx, option),
697                 });
698                 Ok(())
699         }
700 }
701
702 impl Readable for IrrevocablyResolvedHTLC {
703         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
704                 let mut mapped_commitment_tx_output_idx = 0;
705                 let mut resolving_txid = None;
706                 let mut payment_preimage = None;
707                 let mut resolving_tx = None;
708                 read_tlv_fields!(reader, {
709                         (0, mapped_commitment_tx_output_idx, required),
710                         (1, resolving_txid, option),
711                         (2, payment_preimage, option),
712                         (3, resolving_tx, option),
713                 });
714                 Ok(Self {
715                         commitment_tx_output_idx: if mapped_commitment_tx_output_idx == u32::max_value() { None } else { Some(mapped_commitment_tx_output_idx) },
716                         resolving_txid,
717                         payment_preimage,
718                         resolving_tx,
719                 })
720         }
721 }
722
723 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
724 /// on-chain transactions to ensure no loss of funds occurs.
725 ///
726 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
727 /// information and are actively monitoring the chain.
728 ///
729 /// Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
730 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
731 /// the "reorg path" (ie disconnecting blocks until you find a common ancestor from both the
732 /// returned block hash and the the current chain and then reconnecting blocks to get to the
733 /// best chain) upon deserializing the object!
734 pub struct ChannelMonitor<Signer: WriteableEcdsaChannelSigner> {
735         #[cfg(test)]
736         pub(crate) inner: Mutex<ChannelMonitorImpl<Signer>>,
737         #[cfg(not(test))]
738         pub(super) inner: Mutex<ChannelMonitorImpl<Signer>>,
739 }
740
741 impl<Signer: WriteableEcdsaChannelSigner> Clone for ChannelMonitor<Signer> where Signer: Clone {
742         fn clone(&self) -> Self {
743                 let inner = self.inner.lock().unwrap().clone();
744                 ChannelMonitor::from_impl(inner)
745         }
746 }
747
748 #[derive(Clone, PartialEq)]
749 pub(crate) struct ChannelMonitorImpl<Signer: WriteableEcdsaChannelSigner> {
750         latest_update_id: u64,
751         commitment_transaction_number_obscure_factor: u64,
752
753         destination_script: Script,
754         broadcasted_holder_revokable_script: Option<(Script, PublicKey, PublicKey)>,
755         counterparty_payment_script: Script,
756         shutdown_script: Option<Script>,
757
758         channel_keys_id: [u8; 32],
759         holder_revocation_basepoint: PublicKey,
760         funding_info: (OutPoint, Script),
761         current_counterparty_commitment_txid: Option<Txid>,
762         prev_counterparty_commitment_txid: Option<Txid>,
763
764         counterparty_commitment_params: CounterpartyCommitmentParameters,
765         funding_redeemscript: Script,
766         channel_value_satoshis: u64,
767         // first is the idx of the first of the two per-commitment points
768         their_cur_per_commitment_points: Option<(u64, PublicKey, Option<PublicKey>)>,
769
770         on_holder_tx_csv: u16,
771
772         commitment_secrets: CounterpartyCommitmentSecrets,
773         /// The set of outpoints in each counterparty commitment transaction. We always need at least
774         /// the payment hash from `HTLCOutputInCommitment` to claim even a revoked commitment
775         /// transaction broadcast as we need to be able to construct the witness script in all cases.
776         counterparty_claimable_outpoints: HashMap<Txid, Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>>,
777         /// We cannot identify HTLC-Success or HTLC-Timeout transactions by themselves on the chain.
778         /// Nor can we figure out their commitment numbers without the commitment transaction they are
779         /// spending. Thus, in order to claim them via revocation key, we track all the counterparty
780         /// commitment transactions which we find on-chain, mapping them to the commitment number which
781         /// can be used to derive the revocation key and claim the transactions.
782         counterparty_commitment_txn_on_chain: HashMap<Txid, u64>,
783         /// Cache used to make pruning of payment_preimages faster.
784         /// Maps payment_hash values to commitment numbers for counterparty transactions for non-revoked
785         /// counterparty transactions (ie should remain pretty small).
786         /// Serialized to disk but should generally not be sent to Watchtowers.
787         counterparty_hash_commitment_number: HashMap<PaymentHash, u64>,
788
789         counterparty_fulfilled_htlcs: HashMap<SentHTLCId, PaymentPreimage>,
790
791         // We store two holder commitment transactions to avoid any race conditions where we may update
792         // some monitors (potentially on watchtowers) but then fail to update others, resulting in the
793         // various monitors for one channel being out of sync, and us broadcasting a holder
794         // transaction for which we have deleted claim information on some watchtowers.
795         prev_holder_signed_commitment_tx: Option<HolderSignedTx>,
796         current_holder_commitment_tx: HolderSignedTx,
797
798         // Used just for ChannelManager to make sure it has the latest channel data during
799         // deserialization
800         current_counterparty_commitment_number: u64,
801         // Used just for ChannelManager to make sure it has the latest channel data during
802         // deserialization
803         current_holder_commitment_number: u64,
804
805         /// The set of payment hashes from inbound payments for which we know the preimage. Payment
806         /// preimages that are not included in any unrevoked local commitment transaction or unrevoked
807         /// remote commitment transactions are automatically removed when commitment transactions are
808         /// revoked.
809         payment_preimages: HashMap<PaymentHash, PaymentPreimage>,
810
811         // Note that `MonitorEvent`s MUST NOT be generated during update processing, only generated
812         // during chain data processing. This prevents a race in `ChainMonitor::update_channel` (and
813         // presumably user implementations thereof as well) where we update the in-memory channel
814         // object, then before the persistence finishes (as it's all under a read-lock), we return
815         // pending events to the user or to the relevant `ChannelManager`. Then, on reload, we'll have
816         // the pre-event state here, but have processed the event in the `ChannelManager`.
817         // Note that because the `event_lock` in `ChainMonitor` is only taken in
818         // block/transaction-connected events and *not* during block/transaction-disconnected events,
819         // we further MUST NOT generate events during block/transaction-disconnection.
820         pending_monitor_events: Vec<MonitorEvent>,
821
822         pub(super) pending_events: Vec<Event>,
823         pub(super) is_processing_pending_events: bool,
824
825         // Used to track on-chain events (i.e., transactions part of channels confirmed on chain) on
826         // which to take actions once they reach enough confirmations. Each entry includes the
827         // transaction's id and the height when the transaction was confirmed on chain.
828         onchain_events_awaiting_threshold_conf: Vec<OnchainEventEntry>,
829
830         // If we get serialized out and re-read, we need to make sure that the chain monitoring
831         // interface knows about the TXOs that we want to be notified of spends of. We could probably
832         // be smart and derive them from the above storage fields, but its much simpler and more
833         // Obviously Correct (tm) if we just keep track of them explicitly.
834         outputs_to_watch: HashMap<Txid, Vec<(u32, Script)>>,
835
836         #[cfg(test)]
837         pub onchain_tx_handler: OnchainTxHandler<Signer>,
838         #[cfg(not(test))]
839         onchain_tx_handler: OnchainTxHandler<Signer>,
840
841         // This is set when the Channel[Manager] generated a ChannelMonitorUpdate which indicated the
842         // channel has been force-closed. After this is set, no further holder commitment transaction
843         // updates may occur, and we panic!() if one is provided.
844         lockdown_from_offchain: bool,
845
846         // Set once we've signed a holder commitment transaction and handed it over to our
847         // OnchainTxHandler. After this is set, no future updates to our holder commitment transactions
848         // may occur, and we fail any such monitor updates.
849         //
850         // In case of update rejection due to a locally already signed commitment transaction, we
851         // nevertheless store update content to track in case of concurrent broadcast by another
852         // remote monitor out-of-order with regards to the block view.
853         holder_tx_signed: bool,
854
855         // If a spend of the funding output is seen, we set this to true and reject any further
856         // updates. This prevents any further changes in the offchain state no matter the order
857         // of block connection between ChannelMonitors and the ChannelManager.
858         funding_spend_seen: bool,
859
860         /// Set to `Some` of the confirmed transaction spending the funding input of the channel after
861         /// reaching `ANTI_REORG_DELAY` confirmations.
862         funding_spend_confirmed: Option<Txid>,
863
864         confirmed_commitment_tx_counterparty_output: CommitmentTxCounterpartyOutputInfo,
865         /// The set of HTLCs which have been either claimed or failed on chain and have reached
866         /// the requisite confirmations on the claim/fail transaction (either ANTI_REORG_DELAY or the
867         /// spending CSV for revocable outputs).
868         htlcs_resolved_on_chain: Vec<IrrevocablyResolvedHTLC>,
869
870         /// The set of `SpendableOutput` events which we have already passed upstream to be claimed.
871         /// These are tracked explicitly to ensure that we don't generate the same events redundantly
872         /// if users duplicatively confirm old transactions. Specifically for transactions claiming a
873         /// revoked remote outpoint we otherwise have no tracking at all once they've reached
874         /// [`ANTI_REORG_DELAY`], so we have to track them here.
875         spendable_txids_confirmed: Vec<Txid>,
876
877         // We simply modify best_block in Channel's block_connected so that serialization is
878         // consistent but hopefully the users' copy handles block_connected in a consistent way.
879         // (we do *not*, however, update them in update_monitor to ensure any local user copies keep
880         // their best_block from its state and not based on updated copies that didn't run through
881         // the full block_connected).
882         best_block: BestBlock,
883
884         /// The node_id of our counterparty
885         counterparty_node_id: Option<PublicKey>,
886
887         /// Initial counterparty commmitment data needed to recreate the commitment tx
888         /// in the persistence pipeline for third-party watchtowers. This will only be present on
889         /// monitors created after 0.0.117.
890         ///
891         /// Ordering of tuple data: (their_per_commitment_point, feerate_per_kw, to_broadcaster_sats,
892         /// to_countersignatory_sats)
893         initial_counterparty_commitment_info: Option<(PublicKey, u32, u64, u64)>,
894 }
895
896 /// Transaction outputs to watch for on-chain spends.
897 pub type TransactionOutputs = (Txid, Vec<(u32, TxOut)>);
898
899 impl<Signer: WriteableEcdsaChannelSigner> PartialEq for ChannelMonitor<Signer> where Signer: PartialEq {
900         fn eq(&self, other: &Self) -> bool {
901                 // We need some kind of total lockorder. Absent a better idea, we sort by position in
902                 // memory and take locks in that order (assuming that we can't move within memory while a
903                 // lock is held).
904                 let ord = ((self as *const _) as usize) < ((other as *const _) as usize);
905                 let a = if ord { self.inner.unsafe_well_ordered_double_lock_self() } else { other.inner.unsafe_well_ordered_double_lock_self() };
906                 let b = if ord { other.inner.unsafe_well_ordered_double_lock_self() } else { self.inner.unsafe_well_ordered_double_lock_self() };
907                 a.eq(&b)
908         }
909 }
910
911 impl<Signer: WriteableEcdsaChannelSigner> Writeable for ChannelMonitor<Signer> {
912         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
913                 self.inner.lock().unwrap().write(writer)
914         }
915 }
916
917 // These are also used for ChannelMonitorUpdate, above.
918 const SERIALIZATION_VERSION: u8 = 1;
919 const MIN_SERIALIZATION_VERSION: u8 = 1;
920
921 impl<Signer: WriteableEcdsaChannelSigner> Writeable for ChannelMonitorImpl<Signer> {
922         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
923                 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
924
925                 self.latest_update_id.write(writer)?;
926
927                 // Set in initial Channel-object creation, so should always be set by now:
928                 U48(self.commitment_transaction_number_obscure_factor).write(writer)?;
929
930                 self.destination_script.write(writer)?;
931                 if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
932                         writer.write_all(&[0; 1])?;
933                         broadcasted_holder_revokable_script.0.write(writer)?;
934                         broadcasted_holder_revokable_script.1.write(writer)?;
935                         broadcasted_holder_revokable_script.2.write(writer)?;
936                 } else {
937                         writer.write_all(&[1; 1])?;
938                 }
939
940                 self.counterparty_payment_script.write(writer)?;
941                 match &self.shutdown_script {
942                         Some(script) => script.write(writer)?,
943                         None => Script::new().write(writer)?,
944                 }
945
946                 self.channel_keys_id.write(writer)?;
947                 self.holder_revocation_basepoint.write(writer)?;
948                 writer.write_all(&self.funding_info.0.txid[..])?;
949                 writer.write_all(&self.funding_info.0.index.to_be_bytes())?;
950                 self.funding_info.1.write(writer)?;
951                 self.current_counterparty_commitment_txid.write(writer)?;
952                 self.prev_counterparty_commitment_txid.write(writer)?;
953
954                 self.counterparty_commitment_params.write(writer)?;
955                 self.funding_redeemscript.write(writer)?;
956                 self.channel_value_satoshis.write(writer)?;
957
958                 match self.their_cur_per_commitment_points {
959                         Some((idx, pubkey, second_option)) => {
960                                 writer.write_all(&byte_utils::be48_to_array(idx))?;
961                                 writer.write_all(&pubkey.serialize())?;
962                                 match second_option {
963                                         Some(second_pubkey) => {
964                                                 writer.write_all(&second_pubkey.serialize())?;
965                                         },
966                                         None => {
967                                                 writer.write_all(&[0; 33])?;
968                                         },
969                                 }
970                         },
971                         None => {
972                                 writer.write_all(&byte_utils::be48_to_array(0))?;
973                         },
974                 }
975
976                 writer.write_all(&self.on_holder_tx_csv.to_be_bytes())?;
977
978                 self.commitment_secrets.write(writer)?;
979
980                 macro_rules! serialize_htlc_in_commitment {
981                         ($htlc_output: expr) => {
982                                 writer.write_all(&[$htlc_output.offered as u8; 1])?;
983                                 writer.write_all(&$htlc_output.amount_msat.to_be_bytes())?;
984                                 writer.write_all(&$htlc_output.cltv_expiry.to_be_bytes())?;
985                                 writer.write_all(&$htlc_output.payment_hash.0[..])?;
986                                 $htlc_output.transaction_output_index.write(writer)?;
987                         }
988                 }
989
990                 writer.write_all(&(self.counterparty_claimable_outpoints.len() as u64).to_be_bytes())?;
991                 for (ref txid, ref htlc_infos) in self.counterparty_claimable_outpoints.iter() {
992                         writer.write_all(&txid[..])?;
993                         writer.write_all(&(htlc_infos.len() as u64).to_be_bytes())?;
994                         for &(ref htlc_output, ref htlc_source) in htlc_infos.iter() {
995                                 debug_assert!(htlc_source.is_none() || Some(**txid) == self.current_counterparty_commitment_txid
996                                                 || Some(**txid) == self.prev_counterparty_commitment_txid,
997                                         "HTLC Sources for all revoked commitment transactions should be none!");
998                                 serialize_htlc_in_commitment!(htlc_output);
999                                 htlc_source.as_ref().map(|b| b.as_ref()).write(writer)?;
1000                         }
1001                 }
1002
1003                 writer.write_all(&(self.counterparty_commitment_txn_on_chain.len() as u64).to_be_bytes())?;
1004                 for (ref txid, commitment_number) in self.counterparty_commitment_txn_on_chain.iter() {
1005                         writer.write_all(&txid[..])?;
1006                         writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
1007                 }
1008
1009                 writer.write_all(&(self.counterparty_hash_commitment_number.len() as u64).to_be_bytes())?;
1010                 for (ref payment_hash, commitment_number) in self.counterparty_hash_commitment_number.iter() {
1011                         writer.write_all(&payment_hash.0[..])?;
1012                         writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
1013                 }
1014
1015                 if let Some(ref prev_holder_tx) = self.prev_holder_signed_commitment_tx {
1016                         writer.write_all(&[1; 1])?;
1017                         prev_holder_tx.write(writer)?;
1018                 } else {
1019                         writer.write_all(&[0; 1])?;
1020                 }
1021
1022                 self.current_holder_commitment_tx.write(writer)?;
1023
1024                 writer.write_all(&byte_utils::be48_to_array(self.current_counterparty_commitment_number))?;
1025                 writer.write_all(&byte_utils::be48_to_array(self.current_holder_commitment_number))?;
1026
1027                 writer.write_all(&(self.payment_preimages.len() as u64).to_be_bytes())?;
1028                 for payment_preimage in self.payment_preimages.values() {
1029                         writer.write_all(&payment_preimage.0[..])?;
1030                 }
1031
1032                 writer.write_all(&(self.pending_monitor_events.iter().filter(|ev| match ev {
1033                         MonitorEvent::HTLCEvent(_) => true,
1034                         MonitorEvent::HolderForceClosed(_) => true,
1035                         _ => false,
1036                 }).count() as u64).to_be_bytes())?;
1037                 for event in self.pending_monitor_events.iter() {
1038                         match event {
1039                                 MonitorEvent::HTLCEvent(upd) => {
1040                                         0u8.write(writer)?;
1041                                         upd.write(writer)?;
1042                                 },
1043                                 MonitorEvent::HolderForceClosed(_) => 1u8.write(writer)?,
1044                                 _ => {}, // Covered in the TLV writes below
1045                         }
1046                 }
1047
1048                 writer.write_all(&(self.pending_events.len() as u64).to_be_bytes())?;
1049                 for event in self.pending_events.iter() {
1050                         event.write(writer)?;
1051                 }
1052
1053                 self.best_block.block_hash().write(writer)?;
1054                 writer.write_all(&self.best_block.height().to_be_bytes())?;
1055
1056                 writer.write_all(&(self.onchain_events_awaiting_threshold_conf.len() as u64).to_be_bytes())?;
1057                 for ref entry in self.onchain_events_awaiting_threshold_conf.iter() {
1058                         entry.write(writer)?;
1059                 }
1060
1061                 (self.outputs_to_watch.len() as u64).write(writer)?;
1062                 for (txid, idx_scripts) in self.outputs_to_watch.iter() {
1063                         txid.write(writer)?;
1064                         (idx_scripts.len() as u64).write(writer)?;
1065                         for (idx, script) in idx_scripts.iter() {
1066                                 idx.write(writer)?;
1067                                 script.write(writer)?;
1068                         }
1069                 }
1070                 self.onchain_tx_handler.write(writer)?;
1071
1072                 self.lockdown_from_offchain.write(writer)?;
1073                 self.holder_tx_signed.write(writer)?;
1074
1075                 write_tlv_fields!(writer, {
1076                         (1, self.funding_spend_confirmed, option),
1077                         (3, self.htlcs_resolved_on_chain, required_vec),
1078                         (5, self.pending_monitor_events, required_vec),
1079                         (7, self.funding_spend_seen, required),
1080                         (9, self.counterparty_node_id, option),
1081                         (11, self.confirmed_commitment_tx_counterparty_output, option),
1082                         (13, self.spendable_txids_confirmed, required_vec),
1083                         (15, self.counterparty_fulfilled_htlcs, required),
1084                         (17, self.initial_counterparty_commitment_info, option),
1085                 });
1086
1087                 Ok(())
1088         }
1089 }
1090
1091 macro_rules! _process_events_body {
1092         ($self_opt: expr, $event_to_handle: expr, $handle_event: expr) => {
1093                 loop {
1094                         let (pending_events, repeated_events);
1095                         if let Some(us) = $self_opt {
1096                                 let mut inner = us.inner.lock().unwrap();
1097                                 if inner.is_processing_pending_events {
1098                                         break;
1099                                 }
1100                                 inner.is_processing_pending_events = true;
1101
1102                                 pending_events = inner.pending_events.clone();
1103                                 repeated_events = inner.get_repeated_events();
1104                         } else { break; }
1105                         let num_events = pending_events.len();
1106
1107                         for event in pending_events.into_iter().chain(repeated_events.into_iter()) {
1108                                 $event_to_handle = event;
1109                                 $handle_event;
1110                         }
1111
1112                         if let Some(us) = $self_opt {
1113                                 let mut inner = us.inner.lock().unwrap();
1114                                 inner.pending_events.drain(..num_events);
1115                                 inner.is_processing_pending_events = false;
1116                                 if !inner.pending_events.is_empty() {
1117                                         // If there's more events to process, go ahead and do so.
1118                                         continue;
1119                                 }
1120                         }
1121                         break;
1122                 }
1123         }
1124 }
1125 pub(super) use _process_events_body as process_events_body;
1126
1127 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitor<Signer> {
1128         /// For lockorder enforcement purposes, we need to have a single site which constructs the
1129         /// `inner` mutex, otherwise cases where we lock two monitors at the same time (eg in our
1130         /// PartialEq implementation) we may decide a lockorder violation has occurred.
1131         fn from_impl(imp: ChannelMonitorImpl<Signer>) -> Self {
1132                 ChannelMonitor { inner: Mutex::new(imp) }
1133         }
1134
1135         pub(crate) fn new(secp_ctx: Secp256k1<secp256k1::All>, keys: Signer, shutdown_script: Option<Script>,
1136                           on_counterparty_tx_csv: u16, destination_script: &Script, funding_info: (OutPoint, Script),
1137                           channel_parameters: &ChannelTransactionParameters,
1138                           funding_redeemscript: Script, channel_value_satoshis: u64,
1139                           commitment_transaction_number_obscure_factor: u64,
1140                           initial_holder_commitment_tx: HolderCommitmentTransaction,
1141                           best_block: BestBlock, counterparty_node_id: PublicKey) -> ChannelMonitor<Signer> {
1142
1143                 assert!(commitment_transaction_number_obscure_factor <= (1 << 48));
1144                 let counterparty_payment_script = chan_utils::get_counterparty_payment_script(
1145                         &channel_parameters.channel_type_features, &keys.pubkeys().payment_point
1146                 );
1147
1148                 let counterparty_channel_parameters = channel_parameters.counterparty_parameters.as_ref().unwrap();
1149                 let counterparty_delayed_payment_base_key = counterparty_channel_parameters.pubkeys.delayed_payment_basepoint;
1150                 let counterparty_htlc_base_key = counterparty_channel_parameters.pubkeys.htlc_basepoint;
1151                 let counterparty_commitment_params = CounterpartyCommitmentParameters { counterparty_delayed_payment_base_key, counterparty_htlc_base_key, on_counterparty_tx_csv };
1152
1153                 let channel_keys_id = keys.channel_keys_id();
1154                 let holder_revocation_basepoint = keys.pubkeys().revocation_basepoint;
1155
1156                 // block for Rust 1.34 compat
1157                 let (holder_commitment_tx, current_holder_commitment_number) = {
1158                         let trusted_tx = initial_holder_commitment_tx.trust();
1159                         let txid = trusted_tx.txid();
1160
1161                         let tx_keys = trusted_tx.keys();
1162                         let holder_commitment_tx = HolderSignedTx {
1163                                 txid,
1164                                 revocation_key: tx_keys.revocation_key,
1165                                 a_htlc_key: tx_keys.broadcaster_htlc_key,
1166                                 b_htlc_key: tx_keys.countersignatory_htlc_key,
1167                                 delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
1168                                 per_commitment_point: tx_keys.per_commitment_point,
1169                                 htlc_outputs: Vec::new(), // There are never any HTLCs in the initial commitment transactions
1170                                 to_self_value_sat: initial_holder_commitment_tx.to_broadcaster_value_sat(),
1171                                 feerate_per_kw: trusted_tx.feerate_per_kw(),
1172                         };
1173                         (holder_commitment_tx, trusted_tx.commitment_number())
1174                 };
1175
1176                 let onchain_tx_handler =
1177                         OnchainTxHandler::new(destination_script.clone(), keys,
1178                         channel_parameters.clone(), initial_holder_commitment_tx, secp_ctx);
1179
1180                 let mut outputs_to_watch = HashMap::new();
1181                 outputs_to_watch.insert(funding_info.0.txid, vec![(funding_info.0.index as u32, funding_info.1.clone())]);
1182
1183                 Self::from_impl(ChannelMonitorImpl {
1184                         latest_update_id: 0,
1185                         commitment_transaction_number_obscure_factor,
1186
1187                         destination_script: destination_script.clone(),
1188                         broadcasted_holder_revokable_script: None,
1189                         counterparty_payment_script,
1190                         shutdown_script,
1191
1192                         channel_keys_id,
1193                         holder_revocation_basepoint,
1194                         funding_info,
1195                         current_counterparty_commitment_txid: None,
1196                         prev_counterparty_commitment_txid: None,
1197
1198                         counterparty_commitment_params,
1199                         funding_redeemscript,
1200                         channel_value_satoshis,
1201                         their_cur_per_commitment_points: None,
1202
1203                         on_holder_tx_csv: counterparty_channel_parameters.selected_contest_delay,
1204
1205                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
1206                         counterparty_claimable_outpoints: HashMap::new(),
1207                         counterparty_commitment_txn_on_chain: HashMap::new(),
1208                         counterparty_hash_commitment_number: HashMap::new(),
1209                         counterparty_fulfilled_htlcs: HashMap::new(),
1210
1211                         prev_holder_signed_commitment_tx: None,
1212                         current_holder_commitment_tx: holder_commitment_tx,
1213                         current_counterparty_commitment_number: 1 << 48,
1214                         current_holder_commitment_number,
1215
1216                         payment_preimages: HashMap::new(),
1217                         pending_monitor_events: Vec::new(),
1218                         pending_events: Vec::new(),
1219                         is_processing_pending_events: false,
1220
1221                         onchain_events_awaiting_threshold_conf: Vec::new(),
1222                         outputs_to_watch,
1223
1224                         onchain_tx_handler,
1225
1226                         lockdown_from_offchain: false,
1227                         holder_tx_signed: false,
1228                         funding_spend_seen: false,
1229                         funding_spend_confirmed: None,
1230                         confirmed_commitment_tx_counterparty_output: None,
1231                         htlcs_resolved_on_chain: Vec::new(),
1232                         spendable_txids_confirmed: Vec::new(),
1233
1234                         best_block,
1235                         counterparty_node_id: Some(counterparty_node_id),
1236                         initial_counterparty_commitment_info: None,
1237                 })
1238         }
1239
1240         #[cfg(test)]
1241         fn provide_secret(&self, idx: u64, secret: [u8; 32]) -> Result<(), &'static str> {
1242                 self.inner.lock().unwrap().provide_secret(idx, secret)
1243         }
1244
1245         /// A variant of `Self::provide_latest_counterparty_commitment_tx` used to provide
1246         /// additional information to the monitor to store in order to recreate the initial
1247         /// counterparty commitment transaction during persistence (mainly for use in third-party
1248         /// watchtowers).
1249         ///
1250         /// This is used to provide the counterparty commitment information directly to the monitor
1251         /// before the initial persistence of a new channel.
1252         pub(crate) fn provide_initial_counterparty_commitment_tx<L: Deref>(
1253                 &self, txid: Txid, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
1254                 commitment_number: u64, their_cur_per_commitment_point: PublicKey, feerate_per_kw: u32,
1255                 to_broadcaster_value_sat: u64, to_countersignatory_value_sat: u64, logger: &L,
1256         )
1257         where L::Target: Logger
1258         {
1259                 self.inner.lock().unwrap().provide_initial_counterparty_commitment_tx(txid,
1260                         htlc_outputs, commitment_number, their_cur_per_commitment_point, feerate_per_kw,
1261                         to_broadcaster_value_sat, to_countersignatory_value_sat, logger);
1262         }
1263
1264         /// Informs this monitor of the latest counterparty (ie non-broadcastable) commitment transaction.
1265         /// The monitor watches for it to be broadcasted and then uses the HTLC information (and
1266         /// possibly future revocation/preimage information) to claim outputs where possible.
1267         /// We cache also the mapping hash:commitment number to lighten pruning of old preimages by watchtowers.
1268         #[cfg(test)]
1269         fn provide_latest_counterparty_commitment_tx<L: Deref>(
1270                 &self,
1271                 txid: Txid,
1272                 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
1273                 commitment_number: u64,
1274                 their_per_commitment_point: PublicKey,
1275                 logger: &L,
1276         ) where L::Target: Logger {
1277                 self.inner.lock().unwrap().provide_latest_counterparty_commitment_tx(
1278                         txid, htlc_outputs, commitment_number, their_per_commitment_point, logger)
1279         }
1280
1281         #[cfg(test)]
1282         fn provide_latest_holder_commitment_tx(
1283                 &self, holder_commitment_tx: HolderCommitmentTransaction,
1284                 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
1285         ) -> Result<(), ()> {
1286                 self.inner.lock().unwrap().provide_latest_holder_commitment_tx(holder_commitment_tx, htlc_outputs, &Vec::new(), Vec::new()).map_err(|_| ())
1287         }
1288
1289         /// This is used to provide payment preimage(s) out-of-band during startup without updating the
1290         /// off-chain state with a new commitment transaction.
1291         pub(crate) fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
1292                 &self,
1293                 payment_hash: &PaymentHash,
1294                 payment_preimage: &PaymentPreimage,
1295                 broadcaster: &B,
1296                 fee_estimator: &LowerBoundedFeeEstimator<F>,
1297                 logger: &L,
1298         ) where
1299                 B::Target: BroadcasterInterface,
1300                 F::Target: FeeEstimator,
1301                 L::Target: Logger,
1302         {
1303                 self.inner.lock().unwrap().provide_payment_preimage(
1304                         payment_hash, payment_preimage, broadcaster, fee_estimator, logger)
1305         }
1306
1307         /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
1308         /// itself.
1309         ///
1310         /// panics if the given update is not the next update by update_id.
1311         pub fn update_monitor<B: Deref, F: Deref, L: Deref>(
1312                 &self,
1313                 updates: &ChannelMonitorUpdate,
1314                 broadcaster: &B,
1315                 fee_estimator: &F,
1316                 logger: &L,
1317         ) -> Result<(), ()>
1318         where
1319                 B::Target: BroadcasterInterface,
1320                 F::Target: FeeEstimator,
1321                 L::Target: Logger,
1322         {
1323                 self.inner.lock().unwrap().update_monitor(updates, broadcaster, fee_estimator, logger)
1324         }
1325
1326         /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
1327         /// ChannelMonitor.
1328         pub fn get_latest_update_id(&self) -> u64 {
1329                 self.inner.lock().unwrap().get_latest_update_id()
1330         }
1331
1332         /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
1333         pub fn get_funding_txo(&self) -> (OutPoint, Script) {
1334                 self.inner.lock().unwrap().get_funding_txo().clone()
1335         }
1336
1337         /// Gets a list of txids, with their output scripts (in the order they appear in the
1338         /// transaction), which we must learn about spends of via block_connected().
1339         pub fn get_outputs_to_watch(&self) -> Vec<(Txid, Vec<(u32, Script)>)> {
1340                 self.inner.lock().unwrap().get_outputs_to_watch()
1341                         .iter().map(|(txid, outputs)| (*txid, outputs.clone())).collect()
1342         }
1343
1344         /// Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
1345         /// calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
1346         /// have been registered.
1347         pub fn load_outputs_to_watch<F: Deref>(&self, filter: &F) where F::Target: chain::Filter {
1348                 let lock = self.inner.lock().unwrap();
1349                 filter.register_tx(&lock.get_funding_txo().0.txid, &lock.get_funding_txo().1);
1350                 for (txid, outputs) in lock.get_outputs_to_watch().iter() {
1351                         for (index, script_pubkey) in outputs.iter() {
1352                                 assert!(*index <= u16::max_value() as u32);
1353                                 filter.register_output(WatchedOutput {
1354                                         block_hash: None,
1355                                         outpoint: OutPoint { txid: *txid, index: *index as u16 },
1356                                         script_pubkey: script_pubkey.clone(),
1357                                 });
1358                         }
1359                 }
1360         }
1361
1362         /// Get the list of HTLCs who's status has been updated on chain. This should be called by
1363         /// ChannelManager via [`chain::Watch::release_pending_monitor_events`].
1364         pub fn get_and_clear_pending_monitor_events(&self) -> Vec<MonitorEvent> {
1365                 self.inner.lock().unwrap().get_and_clear_pending_monitor_events()
1366         }
1367
1368         /// Processes [`SpendableOutputs`] events produced from each [`ChannelMonitor`] upon maturity.
1369         ///
1370         /// For channels featuring anchor outputs, this method will also process [`BumpTransaction`]
1371         /// events produced from each [`ChannelMonitor`] while there is a balance to claim onchain
1372         /// within each channel. As the confirmation of a commitment transaction may be critical to the
1373         /// safety of funds, we recommend invoking this every 30 seconds, or lower if running in an
1374         /// environment with spotty connections, like on mobile.
1375         ///
1376         /// An [`EventHandler`] may safely call back to the provider, though this shouldn't be needed in
1377         /// order to handle these events.
1378         ///
1379         /// [`SpendableOutputs`]: crate::events::Event::SpendableOutputs
1380         /// [`BumpTransaction`]: crate::events::Event::BumpTransaction
1381         pub fn process_pending_events<H: Deref>(&self, handler: &H) where H::Target: EventHandler {
1382                 let mut ev;
1383                 process_events_body!(Some(self), ev, handler.handle_event(ev));
1384         }
1385
1386         /// Processes any events asynchronously.
1387         ///
1388         /// See [`Self::process_pending_events`] for more information.
1389         pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
1390                 &self, handler: &H
1391         ) {
1392                 let mut ev;
1393                 process_events_body!(Some(self), ev, { handler(ev).await });
1394         }
1395
1396         #[cfg(test)]
1397         pub fn get_and_clear_pending_events(&self) -> Vec<Event> {
1398                 let mut ret = Vec::new();
1399                 let mut lck = self.inner.lock().unwrap();
1400                 mem::swap(&mut ret, &mut lck.pending_events);
1401                 ret.append(&mut lck.get_repeated_events());
1402                 ret
1403         }
1404
1405         /// Gets the counterparty's initial commitment transaction. The returned commitment
1406         /// transaction is unsigned. This is intended to be called during the initial persistence of
1407         /// the monitor (inside an implementation of [`Persist::persist_new_channel`]), to allow for
1408         /// watchtowers in the persistence pipeline to have enough data to form justice transactions.
1409         ///
1410         /// This is similar to [`Self::counterparty_commitment_txs_from_update`], except
1411         /// that for the initial commitment transaction, we don't have a corresponding update.
1412         ///
1413         /// This will only return `Some` for channel monitors that have been created after upgrading
1414         /// to LDK 0.0.117+.
1415         ///
1416         /// [`Persist::persist_new_channel`]: crate::chain::chainmonitor::Persist::persist_new_channel
1417         pub fn initial_counterparty_commitment_tx(&self) -> Option<CommitmentTransaction> {
1418                 self.inner.lock().unwrap().initial_counterparty_commitment_tx()
1419         }
1420
1421         /// Gets all of the counterparty commitment transactions provided by the given update. This
1422         /// may be empty if the update doesn't include any new counterparty commitments. Returned
1423         /// commitment transactions are unsigned.
1424         ///
1425         /// This is provided so that watchtower clients in the persistence pipeline are able to build
1426         /// justice transactions for each counterparty commitment upon each update. It's intended to be
1427         /// used within an implementation of [`Persist::update_persisted_channel`], which is provided
1428         /// with a monitor and an update. Once revoked, signing a justice transaction can be done using
1429         /// [`Self::sign_to_local_justice_tx`].
1430         ///
1431         /// It is expected that a watchtower client may use this method to retrieve the latest counterparty
1432         /// commitment transaction(s), and then hold the necessary data until a later update in which
1433         /// the monitor has been updated with the corresponding revocation data, at which point the
1434         /// monitor can sign the justice transaction.
1435         ///
1436         /// This will only return a non-empty list for monitor updates that have been created after
1437         /// upgrading to LDK 0.0.117+. Note that no restriction lies on the monitors themselves, which
1438         /// may have been created prior to upgrading.
1439         ///
1440         /// [`Persist::update_persisted_channel`]: crate::chain::chainmonitor::Persist::update_persisted_channel
1441         pub fn counterparty_commitment_txs_from_update(&self, update: &ChannelMonitorUpdate) -> Vec<CommitmentTransaction> {
1442                 self.inner.lock().unwrap().counterparty_commitment_txs_from_update(update)
1443         }
1444
1445         /// Wrapper around [`EcdsaChannelSigner::sign_justice_revoked_output`] to make
1446         /// signing the justice transaction easier for implementors of
1447         /// [`chain::chainmonitor::Persist`]. On success this method returns the provided transaction
1448         /// signing the input at `input_idx`. This method will only produce a valid signature for
1449         /// a transaction spending the `to_local` output of a commitment transaction, i.e. this cannot
1450         /// be used for revoked HTLC outputs.
1451         ///
1452         /// `Value` is the value of the output being spent by the input at `input_idx`, committed
1453         /// in the BIP 143 signature.
1454         ///
1455         /// This method will only succeed if this monitor has received the revocation secret for the
1456         /// provided `commitment_number`. If a commitment number is provided that does not correspond
1457         /// to the commitment transaction being revoked, this will return a signed transaction, but
1458         /// the signature will not be valid.
1459         ///
1460         /// [`EcdsaChannelSigner::sign_justice_revoked_output`]: crate::sign::EcdsaChannelSigner::sign_justice_revoked_output
1461         /// [`Persist`]: crate::chain::chainmonitor::Persist
1462         pub fn sign_to_local_justice_tx(&self, justice_tx: Transaction, input_idx: usize, value: u64, commitment_number: u64) -> Result<Transaction, ()> {
1463                 self.inner.lock().unwrap().sign_to_local_justice_tx(justice_tx, input_idx, value, commitment_number)
1464         }
1465
1466         pub(crate) fn get_min_seen_secret(&self) -> u64 {
1467                 self.inner.lock().unwrap().get_min_seen_secret()
1468         }
1469
1470         pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
1471                 self.inner.lock().unwrap().get_cur_counterparty_commitment_number()
1472         }
1473
1474         pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
1475                 self.inner.lock().unwrap().get_cur_holder_commitment_number()
1476         }
1477
1478         /// Gets the `node_id` of the counterparty for this channel.
1479         ///
1480         /// Will be `None` for channels constructed on LDK versions prior to 0.0.110 and always `Some`
1481         /// otherwise.
1482         pub fn get_counterparty_node_id(&self) -> Option<PublicKey> {
1483                 self.inner.lock().unwrap().counterparty_node_id
1484         }
1485
1486         /// Used by [`ChannelManager`] deserialization to broadcast the latest holder state if its copy
1487         /// of the channel state was out-of-date.
1488         ///
1489         /// You may also use this to broadcast the latest local commitment transaction, either because
1490         /// a monitor update failed or because we've fallen behind (i.e. we've received proof that our
1491         /// counterparty side knows a revocation secret we gave them that they shouldn't know).
1492         ///
1493         /// Broadcasting these transactions in the second case is UNSAFE, as they allow counterparty
1494         /// side to punish you. Nevertheless you may want to broadcast them if counterparty doesn't
1495         /// close channel with their commitment transaction after a substantial amount of time. Best
1496         /// may be to contact the other node operator out-of-band to coordinate other options available
1497         /// to you.
1498         ///
1499         /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
1500         pub fn get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1501         where L::Target: Logger {
1502                 self.inner.lock().unwrap().get_latest_holder_commitment_txn(logger)
1503         }
1504
1505         /// Unsafe test-only version of get_latest_holder_commitment_txn used by our test framework
1506         /// to bypass HolderCommitmentTransaction state update lockdown after signature and generate
1507         /// revoked commitment transaction.
1508         #[cfg(any(test, feature = "unsafe_revoked_tx_signing"))]
1509         pub fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&self, logger: &L) -> Vec<Transaction>
1510         where L::Target: Logger {
1511                 self.inner.lock().unwrap().unsafe_get_latest_holder_commitment_txn(logger)
1512         }
1513
1514         /// Processes transactions in a newly connected block, which may result in any of the following:
1515         /// - update the monitor's state against resolved HTLCs
1516         /// - punish the counterparty in the case of seeing a revoked commitment transaction
1517         /// - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
1518         /// - detect settled outputs for later spending
1519         /// - schedule and bump any in-flight claims
1520         ///
1521         /// Returns any new outputs to watch from `txdata`; after called, these are also included in
1522         /// [`get_outputs_to_watch`].
1523         ///
1524         /// [`get_outputs_to_watch`]: #method.get_outputs_to_watch
1525         pub fn block_connected<B: Deref, F: Deref, L: Deref>(
1526                 &self,
1527                 header: &BlockHeader,
1528                 txdata: &TransactionData,
1529                 height: u32,
1530                 broadcaster: B,
1531                 fee_estimator: F,
1532                 logger: L,
1533         ) -> Vec<TransactionOutputs>
1534         where
1535                 B::Target: BroadcasterInterface,
1536                 F::Target: FeeEstimator,
1537                 L::Target: Logger,
1538         {
1539                 self.inner.lock().unwrap().block_connected(
1540                         header, txdata, height, broadcaster, fee_estimator, logger)
1541         }
1542
1543         /// Determines if the disconnected block contained any transactions of interest and updates
1544         /// appropriately.
1545         pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(
1546                 &self,
1547                 header: &BlockHeader,
1548                 height: u32,
1549                 broadcaster: B,
1550                 fee_estimator: F,
1551                 logger: L,
1552         ) where
1553                 B::Target: BroadcasterInterface,
1554                 F::Target: FeeEstimator,
1555                 L::Target: Logger,
1556         {
1557                 self.inner.lock().unwrap().block_disconnected(
1558                         header, height, broadcaster, fee_estimator, logger)
1559         }
1560
1561         /// Processes transactions confirmed in a block with the given header and height, returning new
1562         /// outputs to watch. See [`block_connected`] for details.
1563         ///
1564         /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1565         /// blocks. See [`chain::Confirm`] for calling expectations.
1566         ///
1567         /// [`block_connected`]: Self::block_connected
1568         pub fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
1569                 &self,
1570                 header: &BlockHeader,
1571                 txdata: &TransactionData,
1572                 height: u32,
1573                 broadcaster: B,
1574                 fee_estimator: F,
1575                 logger: L,
1576         ) -> Vec<TransactionOutputs>
1577         where
1578                 B::Target: BroadcasterInterface,
1579                 F::Target: FeeEstimator,
1580                 L::Target: Logger,
1581         {
1582                 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1583                 self.inner.lock().unwrap().transactions_confirmed(
1584                         header, txdata, height, broadcaster, &bounded_fee_estimator, logger)
1585         }
1586
1587         /// Processes a transaction that was reorganized out of the chain.
1588         ///
1589         /// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
1590         /// than blocks. See [`chain::Confirm`] for calling expectations.
1591         ///
1592         /// [`block_disconnected`]: Self::block_disconnected
1593         pub fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
1594                 &self,
1595                 txid: &Txid,
1596                 broadcaster: B,
1597                 fee_estimator: F,
1598                 logger: L,
1599         ) where
1600                 B::Target: BroadcasterInterface,
1601                 F::Target: FeeEstimator,
1602                 L::Target: Logger,
1603         {
1604                 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1605                 self.inner.lock().unwrap().transaction_unconfirmed(
1606                         txid, broadcaster, &bounded_fee_estimator, logger);
1607         }
1608
1609         /// Updates the monitor with the current best chain tip, returning new outputs to watch. See
1610         /// [`block_connected`] for details.
1611         ///
1612         /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
1613         /// blocks. See [`chain::Confirm`] for calling expectations.
1614         ///
1615         /// [`block_connected`]: Self::block_connected
1616         pub fn best_block_updated<B: Deref, F: Deref, L: Deref>(
1617                 &self,
1618                 header: &BlockHeader,
1619                 height: u32,
1620                 broadcaster: B,
1621                 fee_estimator: F,
1622                 logger: L,
1623         ) -> Vec<TransactionOutputs>
1624         where
1625                 B::Target: BroadcasterInterface,
1626                 F::Target: FeeEstimator,
1627                 L::Target: Logger,
1628         {
1629                 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1630                 self.inner.lock().unwrap().best_block_updated(
1631                         header, height, broadcaster, &bounded_fee_estimator, logger)
1632         }
1633
1634         /// Returns the set of txids that should be monitored for re-organization out of the chain.
1635         pub fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
1636                 let inner = self.inner.lock().unwrap();
1637                 let mut txids: Vec<(Txid, Option<BlockHash>)> = inner.onchain_events_awaiting_threshold_conf
1638                         .iter()
1639                         .map(|entry| (entry.txid, entry.block_hash))
1640                         .chain(inner.onchain_tx_handler.get_relevant_txids().into_iter())
1641                         .collect();
1642                 txids.sort_unstable();
1643                 txids.dedup();
1644                 txids
1645         }
1646
1647         /// Gets the latest best block which was connected either via the [`chain::Listen`] or
1648         /// [`chain::Confirm`] interfaces.
1649         pub fn current_best_block(&self) -> BestBlock {
1650                 self.inner.lock().unwrap().best_block.clone()
1651         }
1652
1653         /// Triggers rebroadcasts/fee-bumps of pending claims from a force-closed channel. This is
1654         /// crucial in preventing certain classes of pinning attacks, detecting substantial mempool
1655         /// feerate changes between blocks, and ensuring reliability if broadcasting fails. We recommend
1656         /// invoking this every 30 seconds, or lower if running in an environment with spotty
1657         /// connections, like on mobile.
1658         pub fn rebroadcast_pending_claims<B: Deref, F: Deref, L: Deref>(
1659                 &self, broadcaster: B, fee_estimator: F, logger: L,
1660         )
1661         where
1662                 B::Target: BroadcasterInterface,
1663                 F::Target: FeeEstimator,
1664                 L::Target: Logger,
1665         {
1666                 let fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
1667                 let mut inner = self.inner.lock().unwrap();
1668                 let current_height = inner.best_block.height;
1669                 inner.onchain_tx_handler.rebroadcast_pending_claims(
1670                         current_height, &broadcaster, &fee_estimator, &logger,
1671                 );
1672         }
1673
1674         /// Returns the descriptors for relevant outputs (i.e., those that we can spend) within the
1675         /// transaction if they exist and the transaction has at least [`ANTI_REORG_DELAY`]
1676         /// confirmations. For [`SpendableOutputDescriptor::DelayedPaymentOutput`] descriptors to be
1677         /// returned, the transaction must have at least `max(ANTI_REORG_DELAY, to_self_delay)`
1678         /// confirmations.
1679         ///
1680         /// Descriptors returned by this method are primarily exposed via [`Event::SpendableOutputs`]
1681         /// once they are no longer under reorg risk. This method serves as a way to retrieve these
1682         /// descriptors at a later time, either for historical purposes, or to replay any
1683         /// missed/unhandled descriptors. For the purpose of gathering historical records, if the
1684         /// channel close has fully resolved (i.e., [`ChannelMonitor::get_claimable_balances`] returns
1685         /// an empty set), you can retrieve all spendable outputs by providing all descendant spending
1686         /// transactions starting from the channel's funding transaction and going down three levels.
1687         ///
1688         /// `tx` is a transaction we'll scan the outputs of. Any transaction can be provided. If any
1689         /// outputs which can be spent by us are found, at least one descriptor is returned.
1690         ///
1691         /// `confirmation_height` must be the height of the block in which `tx` was included in.
1692         pub fn get_spendable_outputs(&self, tx: &Transaction, confirmation_height: u32) -> Vec<SpendableOutputDescriptor> {
1693                 let inner = self.inner.lock().unwrap();
1694                 let current_height = inner.best_block.height;
1695                 let mut spendable_outputs = inner.get_spendable_outputs(tx);
1696                 spendable_outputs.retain(|descriptor| {
1697                         let mut conf_threshold = current_height.saturating_sub(ANTI_REORG_DELAY) + 1;
1698                         if let SpendableOutputDescriptor::DelayedPaymentOutput(descriptor) = descriptor {
1699                                 conf_threshold = cmp::min(conf_threshold,
1700                                         current_height.saturating_sub(descriptor.to_self_delay as u32) + 1);
1701                         }
1702                         conf_threshold >= confirmation_height
1703                 });
1704                 spendable_outputs
1705         }
1706
1707         #[cfg(test)]
1708         pub fn get_counterparty_payment_script(&self) -> Script{
1709                 self.inner.lock().unwrap().counterparty_payment_script.clone()
1710         }
1711
1712         #[cfg(test)]
1713         pub fn set_counterparty_payment_script(&self, script: Script) {
1714                 self.inner.lock().unwrap().counterparty_payment_script = script;
1715         }
1716 }
1717
1718 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitorImpl<Signer> {
1719         /// Helper for get_claimable_balances which does the work for an individual HTLC, generating up
1720         /// to one `Balance` for the HTLC.
1721         fn get_htlc_balance(&self, htlc: &HTLCOutputInCommitment, holder_commitment: bool,
1722                 counterparty_revoked_commitment: bool, confirmed_txid: Option<Txid>)
1723         -> Option<Balance> {
1724                 let htlc_commitment_tx_output_idx =
1725                         if let Some(v) = htlc.transaction_output_index { v } else { return None; };
1726
1727                 let mut htlc_spend_txid_opt = None;
1728                 let mut htlc_spend_tx_opt = None;
1729                 let mut holder_timeout_spend_pending = None;
1730                 let mut htlc_spend_pending = None;
1731                 let mut holder_delayed_output_pending = None;
1732                 for event in self.onchain_events_awaiting_threshold_conf.iter() {
1733                         match event.event {
1734                                 OnchainEvent::HTLCUpdate { commitment_tx_output_idx, htlc_value_satoshis, .. }
1735                                 if commitment_tx_output_idx == Some(htlc_commitment_tx_output_idx) => {
1736                                         debug_assert!(htlc_spend_txid_opt.is_none());
1737                                         htlc_spend_txid_opt = Some(&event.txid);
1738                                         debug_assert!(htlc_spend_tx_opt.is_none());
1739                                         htlc_spend_tx_opt = event.transaction.as_ref();
1740                                         debug_assert!(holder_timeout_spend_pending.is_none());
1741                                         debug_assert_eq!(htlc_value_satoshis.unwrap(), htlc.amount_msat / 1000);
1742                                         holder_timeout_spend_pending = Some(event.confirmation_threshold());
1743                                 },
1744                                 OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, preimage, .. }
1745                                 if commitment_tx_output_idx == htlc_commitment_tx_output_idx => {
1746                                         debug_assert!(htlc_spend_txid_opt.is_none());
1747                                         htlc_spend_txid_opt = Some(&event.txid);
1748                                         debug_assert!(htlc_spend_tx_opt.is_none());
1749                                         htlc_spend_tx_opt = event.transaction.as_ref();
1750                                         debug_assert!(htlc_spend_pending.is_none());
1751                                         htlc_spend_pending = Some((event.confirmation_threshold(), preimage.is_some()));
1752                                 },
1753                                 OnchainEvent::MaturingOutput {
1754                                         descriptor: SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor) }
1755                                 if event.transaction.as_ref().map(|tx| tx.input.iter().enumerate()
1756                                         .any(|(input_idx, inp)|
1757                                                  Some(inp.previous_output.txid) == confirmed_txid &&
1758                                                         inp.previous_output.vout == htlc_commitment_tx_output_idx &&
1759                                                                 // A maturing output for an HTLC claim will always be at the same
1760                                                                 // index as the HTLC input. This is true pre-anchors, as there's
1761                                                                 // only 1 input and 1 output. This is also true post-anchors,
1762                                                                 // because we have a SIGHASH_SINGLE|ANYONECANPAY signature from our
1763                                                                 // channel counterparty.
1764                                                                 descriptor.outpoint.index as usize == input_idx
1765                                         ))
1766                                         .unwrap_or(false)
1767                                 => {
1768                                         debug_assert!(holder_delayed_output_pending.is_none());
1769                                         holder_delayed_output_pending = Some(event.confirmation_threshold());
1770                                 },
1771                                 _ => {},
1772                         }
1773                 }
1774                 let htlc_resolved = self.htlcs_resolved_on_chain.iter()
1775                         .find(|v| if v.commitment_tx_output_idx == Some(htlc_commitment_tx_output_idx) {
1776                                 debug_assert!(htlc_spend_txid_opt.is_none());
1777                                 htlc_spend_txid_opt = v.resolving_txid.as_ref();
1778                                 debug_assert!(htlc_spend_tx_opt.is_none());
1779                                 htlc_spend_tx_opt = v.resolving_tx.as_ref();
1780                                 true
1781                         } else { false });
1782                 debug_assert!(holder_timeout_spend_pending.is_some() as u8 + htlc_spend_pending.is_some() as u8 + htlc_resolved.is_some() as u8 <= 1);
1783
1784                 let htlc_commitment_outpoint = BitcoinOutPoint::new(confirmed_txid.unwrap(), htlc_commitment_tx_output_idx);
1785                 let htlc_output_to_spend =
1786                         if let Some(txid) = htlc_spend_txid_opt {
1787                                 // Because HTLC transactions either only have 1 input and 1 output (pre-anchors) or
1788                                 // are signed with SIGHASH_SINGLE|ANYONECANPAY under BIP-0143 (post-anchors), we can
1789                                 // locate the correct output by ensuring its adjacent input spends the HTLC output
1790                                 // in the commitment.
1791                                 if let Some(ref tx) = htlc_spend_tx_opt {
1792                                         let htlc_input_idx_opt = tx.input.iter().enumerate()
1793                                                 .find(|(_, input)| input.previous_output == htlc_commitment_outpoint)
1794                                                 .map(|(idx, _)| idx as u32);
1795                                         debug_assert!(htlc_input_idx_opt.is_some());
1796                                         BitcoinOutPoint::new(*txid, htlc_input_idx_opt.unwrap_or(0))
1797                                 } else {
1798                                         debug_assert!(!self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx());
1799                                         BitcoinOutPoint::new(*txid, 0)
1800                                 }
1801                         } else {
1802                                 htlc_commitment_outpoint
1803                         };
1804                 let htlc_output_spend_pending = self.onchain_tx_handler.is_output_spend_pending(&htlc_output_to_spend);
1805
1806                 if let Some(conf_thresh) = holder_delayed_output_pending {
1807                         debug_assert!(holder_commitment);
1808                         return Some(Balance::ClaimableAwaitingConfirmations {
1809                                 amount_satoshis: htlc.amount_msat / 1000,
1810                                 confirmation_height: conf_thresh,
1811                         });
1812                 } else if htlc_resolved.is_some() && !htlc_output_spend_pending {
1813                         // Funding transaction spends should be fully confirmed by the time any
1814                         // HTLC transactions are resolved, unless we're talking about a holder
1815                         // commitment tx, whose resolution is delayed until the CSV timeout is
1816                         // reached, even though HTLCs may be resolved after only
1817                         // ANTI_REORG_DELAY confirmations.
1818                         debug_assert!(holder_commitment || self.funding_spend_confirmed.is_some());
1819                 } else if counterparty_revoked_commitment {
1820                         let htlc_output_claim_pending = self.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1821                                 if let OnchainEvent::MaturingOutput {
1822                                         descriptor: SpendableOutputDescriptor::StaticOutput { .. }
1823                                 } = &event.event {
1824                                         if event.transaction.as_ref().map(|tx| tx.input.iter().any(|inp| {
1825                                                 if let Some(htlc_spend_txid) = htlc_spend_txid_opt {
1826                                                         tx.txid() == *htlc_spend_txid || inp.previous_output.txid == *htlc_spend_txid
1827                                                 } else {
1828                                                         Some(inp.previous_output.txid) == confirmed_txid &&
1829                                                                 inp.previous_output.vout == htlc_commitment_tx_output_idx
1830                                                 }
1831                                         })).unwrap_or(false) {
1832                                                 Some(())
1833                                         } else { None }
1834                                 } else { None }
1835                         });
1836                         if htlc_output_claim_pending.is_some() {
1837                                 // We already push `Balance`s onto the `res` list for every
1838                                 // `StaticOutput` in a `MaturingOutput` in the revoked
1839                                 // counterparty commitment transaction case generally, so don't
1840                                 // need to do so again here.
1841                         } else {
1842                                 debug_assert!(holder_timeout_spend_pending.is_none(),
1843                                         "HTLCUpdate OnchainEvents should never appear for preimage claims");
1844                                 debug_assert!(!htlc.offered || htlc_spend_pending.is_none() || !htlc_spend_pending.unwrap().1,
1845                                         "We don't (currently) generate preimage claims against revoked outputs, where did you get one?!");
1846                                 return Some(Balance::CounterpartyRevokedOutputClaimable {
1847                                         amount_satoshis: htlc.amount_msat / 1000,
1848                                 });
1849                         }
1850                 } else if htlc.offered == holder_commitment {
1851                         // If the payment was outbound, check if there's an HTLCUpdate
1852                         // indicating we have spent this HTLC with a timeout, claiming it back
1853                         // and awaiting confirmations on it.
1854                         if let Some(conf_thresh) = holder_timeout_spend_pending {
1855                                 return Some(Balance::ClaimableAwaitingConfirmations {
1856                                         amount_satoshis: htlc.amount_msat / 1000,
1857                                         confirmation_height: conf_thresh,
1858                                 });
1859                         } else {
1860                                 return Some(Balance::MaybeTimeoutClaimableHTLC {
1861                                         amount_satoshis: htlc.amount_msat / 1000,
1862                                         claimable_height: htlc.cltv_expiry,
1863                                         payment_hash: htlc.payment_hash,
1864                                 });
1865                         }
1866                 } else if let Some(payment_preimage) = self.payment_preimages.get(&htlc.payment_hash) {
1867                         // Otherwise (the payment was inbound), only expose it as claimable if
1868                         // we know the preimage.
1869                         // Note that if there is a pending claim, but it did not use the
1870                         // preimage, we lost funds to our counterparty! We will then continue
1871                         // to show it as ContentiousClaimable until ANTI_REORG_DELAY.
1872                         debug_assert!(holder_timeout_spend_pending.is_none());
1873                         if let Some((conf_thresh, true)) = htlc_spend_pending {
1874                                 return Some(Balance::ClaimableAwaitingConfirmations {
1875                                         amount_satoshis: htlc.amount_msat / 1000,
1876                                         confirmation_height: conf_thresh,
1877                                 });
1878                         } else {
1879                                 return Some(Balance::ContentiousClaimable {
1880                                         amount_satoshis: htlc.amount_msat / 1000,
1881                                         timeout_height: htlc.cltv_expiry,
1882                                         payment_hash: htlc.payment_hash,
1883                                         payment_preimage: *payment_preimage,
1884                                 });
1885                         }
1886                 } else if htlc_resolved.is_none() {
1887                         return Some(Balance::MaybePreimageClaimableHTLC {
1888                                 amount_satoshis: htlc.amount_msat / 1000,
1889                                 expiry_height: htlc.cltv_expiry,
1890                                 payment_hash: htlc.payment_hash,
1891                         });
1892                 }
1893                 None
1894         }
1895 }
1896
1897 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitor<Signer> {
1898         /// Gets the balances in this channel which are either claimable by us if we were to
1899         /// force-close the channel now or which are claimable on-chain (possibly awaiting
1900         /// confirmation).
1901         ///
1902         /// Any balances in the channel which are available on-chain (excluding on-chain fees) are
1903         /// included here until an [`Event::SpendableOutputs`] event has been generated for the
1904         /// balance, or until our counterparty has claimed the balance and accrued several
1905         /// confirmations on the claim transaction.
1906         ///
1907         /// Note that for `ChannelMonitors` which track a channel which went on-chain with versions of
1908         /// LDK prior to 0.0.111, not all or excess balances may be included.
1909         ///
1910         /// See [`Balance`] for additional details on the types of claimable balances which
1911         /// may be returned here and their meanings.
1912         pub fn get_claimable_balances(&self) -> Vec<Balance> {
1913                 let mut res = Vec::new();
1914                 let us = self.inner.lock().unwrap();
1915
1916                 let mut confirmed_txid = us.funding_spend_confirmed;
1917                 let mut confirmed_counterparty_output = us.confirmed_commitment_tx_counterparty_output;
1918                 let mut pending_commitment_tx_conf_thresh = None;
1919                 let funding_spend_pending = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1920                         if let OnchainEvent::FundingSpendConfirmation { commitment_tx_to_counterparty_output, .. } =
1921                                 event.event
1922                         {
1923                                 confirmed_counterparty_output = commitment_tx_to_counterparty_output;
1924                                 Some((event.txid, event.confirmation_threshold()))
1925                         } else { None }
1926                 });
1927                 if let Some((txid, conf_thresh)) = funding_spend_pending {
1928                         debug_assert!(us.funding_spend_confirmed.is_none(),
1929                                 "We have a pending funding spend awaiting anti-reorg confirmation, we can't have confirmed it already!");
1930                         confirmed_txid = Some(txid);
1931                         pending_commitment_tx_conf_thresh = Some(conf_thresh);
1932                 }
1933
1934                 macro_rules! walk_htlcs {
1935                         ($holder_commitment: expr, $counterparty_revoked_commitment: expr, $htlc_iter: expr) => {
1936                                 for htlc in $htlc_iter {
1937                                         if htlc.transaction_output_index.is_some() {
1938
1939                                                 if let Some(bal) = us.get_htlc_balance(htlc, $holder_commitment, $counterparty_revoked_commitment, confirmed_txid) {
1940                                                         res.push(bal);
1941                                                 }
1942                                         }
1943                                 }
1944                         }
1945                 }
1946
1947                 if let Some(txid) = confirmed_txid {
1948                         let mut found_commitment_tx = false;
1949                         if let Some(counterparty_tx_htlcs) = us.counterparty_claimable_outpoints.get(&txid) {
1950                                 // First look for the to_remote output back to us.
1951                                 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
1952                                         if let Some(value) = us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
1953                                                 if let OnchainEvent::MaturingOutput {
1954                                                         descriptor: SpendableOutputDescriptor::StaticPaymentOutput(descriptor)
1955                                                 } = &event.event {
1956                                                         Some(descriptor.output.value)
1957                                                 } else { None }
1958                                         }) {
1959                                                 res.push(Balance::ClaimableAwaitingConfirmations {
1960                                                         amount_satoshis: value,
1961                                                         confirmation_height: conf_thresh,
1962                                                 });
1963                                         } else {
1964                                                 // If a counterparty commitment transaction is awaiting confirmation, we
1965                                                 // should either have a StaticPaymentOutput MaturingOutput event awaiting
1966                                                 // confirmation with the same height or have never met our dust amount.
1967                                         }
1968                                 }
1969                                 if Some(txid) == us.current_counterparty_commitment_txid || Some(txid) == us.prev_counterparty_commitment_txid {
1970                                         walk_htlcs!(false, false, counterparty_tx_htlcs.iter().map(|(a, _)| a));
1971                                 } else {
1972                                         walk_htlcs!(false, true, counterparty_tx_htlcs.iter().map(|(a, _)| a));
1973                                         // The counterparty broadcasted a revoked state!
1974                                         // Look for any StaticOutputs first, generating claimable balances for those.
1975                                         // If any match the confirmed counterparty revoked to_self output, skip
1976                                         // generating a CounterpartyRevokedOutputClaimable.
1977                                         let mut spent_counterparty_output = false;
1978                                         for event in us.onchain_events_awaiting_threshold_conf.iter() {
1979                                                 if let OnchainEvent::MaturingOutput {
1980                                                         descriptor: SpendableOutputDescriptor::StaticOutput { output, .. }
1981                                                 } = &event.event {
1982                                                         res.push(Balance::ClaimableAwaitingConfirmations {
1983                                                                 amount_satoshis: output.value,
1984                                                                 confirmation_height: event.confirmation_threshold(),
1985                                                         });
1986                                                         if let Some(confirmed_to_self_idx) = confirmed_counterparty_output.map(|(idx, _)| idx) {
1987                                                                 if event.transaction.as_ref().map(|tx|
1988                                                                         tx.input.iter().any(|inp| inp.previous_output.vout == confirmed_to_self_idx)
1989                                                                 ).unwrap_or(false) {
1990                                                                         spent_counterparty_output = true;
1991                                                                 }
1992                                                         }
1993                                                 }
1994                                         }
1995
1996                                         if spent_counterparty_output {
1997                                         } else if let Some((confirmed_to_self_idx, amt)) = confirmed_counterparty_output {
1998                                                 let output_spendable = us.onchain_tx_handler
1999                                                         .is_output_spend_pending(&BitcoinOutPoint::new(txid, confirmed_to_self_idx));
2000                                                 if output_spendable {
2001                                                         res.push(Balance::CounterpartyRevokedOutputClaimable {
2002                                                                 amount_satoshis: amt,
2003                                                         });
2004                                                 }
2005                                         } else {
2006                                                 // Counterparty output is missing, either it was broadcasted on a
2007                                                 // previous version of LDK or the counterparty hadn't met dust.
2008                                         }
2009                                 }
2010                                 found_commitment_tx = true;
2011                         } else if txid == us.current_holder_commitment_tx.txid {
2012                                 walk_htlcs!(true, false, us.current_holder_commitment_tx.htlc_outputs.iter().map(|(a, _, _)| a));
2013                                 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
2014                                         res.push(Balance::ClaimableAwaitingConfirmations {
2015                                                 amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
2016                                                 confirmation_height: conf_thresh,
2017                                         });
2018                                 }
2019                                 found_commitment_tx = true;
2020                         } else if let Some(prev_commitment) = &us.prev_holder_signed_commitment_tx {
2021                                 if txid == prev_commitment.txid {
2022                                         walk_htlcs!(true, false, prev_commitment.htlc_outputs.iter().map(|(a, _, _)| a));
2023                                         if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
2024                                                 res.push(Balance::ClaimableAwaitingConfirmations {
2025                                                         amount_satoshis: prev_commitment.to_self_value_sat,
2026                                                         confirmation_height: conf_thresh,
2027                                                 });
2028                                         }
2029                                         found_commitment_tx = true;
2030                                 }
2031                         }
2032                         if !found_commitment_tx {
2033                                 if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
2034                                         // We blindly assume this is a cooperative close transaction here, and that
2035                                         // neither us nor our counterparty misbehaved. At worst we've under-estimated
2036                                         // the amount we can claim as we'll punish a misbehaving counterparty.
2037                                         res.push(Balance::ClaimableAwaitingConfirmations {
2038                                                 amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
2039                                                 confirmation_height: conf_thresh,
2040                                         });
2041                                 }
2042                         }
2043                 } else {
2044                         let mut claimable_inbound_htlc_value_sat = 0;
2045                         for (htlc, _, _) in us.current_holder_commitment_tx.htlc_outputs.iter() {
2046                                 if htlc.transaction_output_index.is_none() { continue; }
2047                                 if htlc.offered {
2048                                         res.push(Balance::MaybeTimeoutClaimableHTLC {
2049                                                 amount_satoshis: htlc.amount_msat / 1000,
2050                                                 claimable_height: htlc.cltv_expiry,
2051                                                 payment_hash: htlc.payment_hash,
2052                                         });
2053                                 } else if us.payment_preimages.get(&htlc.payment_hash).is_some() {
2054                                         claimable_inbound_htlc_value_sat += htlc.amount_msat / 1000;
2055                                 } else {
2056                                         // As long as the HTLC is still in our latest commitment state, treat
2057                                         // it as potentially claimable, even if it has long-since expired.
2058                                         res.push(Balance::MaybePreimageClaimableHTLC {
2059                                                 amount_satoshis: htlc.amount_msat / 1000,
2060                                                 expiry_height: htlc.cltv_expiry,
2061                                                 payment_hash: htlc.payment_hash,
2062                                         });
2063                                 }
2064                         }
2065                         res.push(Balance::ClaimableOnChannelClose {
2066                                 amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat + claimable_inbound_htlc_value_sat,
2067                         });
2068                 }
2069
2070                 res
2071         }
2072
2073         /// Gets the set of outbound HTLCs which can be (or have been) resolved by this
2074         /// `ChannelMonitor`. This is used to determine if an HTLC was removed from the channel prior
2075         /// to the `ChannelManager` having been persisted.
2076         ///
2077         /// This is similar to [`Self::get_pending_or_resolved_outbound_htlcs`] except it includes
2078         /// HTLCs which were resolved on-chain (i.e. where the final HTLC resolution was done by an
2079         /// event from this `ChannelMonitor`).
2080         pub(crate) fn get_all_current_outbound_htlcs(&self) -> HashMap<HTLCSource, (HTLCOutputInCommitment, Option<PaymentPreimage>)> {
2081                 let mut res = HashMap::new();
2082                 // Just examine the available counterparty commitment transactions. See docs on
2083                 // `fail_unbroadcast_htlcs`, below, for justification.
2084                 let us = self.inner.lock().unwrap();
2085                 macro_rules! walk_counterparty_commitment {
2086                         ($txid: expr) => {
2087                                 if let Some(ref latest_outpoints) = us.counterparty_claimable_outpoints.get($txid) {
2088                                         for &(ref htlc, ref source_option) in latest_outpoints.iter() {
2089                                                 if let &Some(ref source) = source_option {
2090                                                         res.insert((**source).clone(), (htlc.clone(),
2091                                                                 us.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).cloned()));
2092                                                 }
2093                                         }
2094                                 }
2095                         }
2096                 }
2097                 if let Some(ref txid) = us.current_counterparty_commitment_txid {
2098                         walk_counterparty_commitment!(txid);
2099                 }
2100                 if let Some(ref txid) = us.prev_counterparty_commitment_txid {
2101                         walk_counterparty_commitment!(txid);
2102                 }
2103                 res
2104         }
2105
2106         /// Gets the set of outbound HTLCs which are pending resolution in this channel or which were
2107         /// resolved with a preimage from our counterparty.
2108         ///
2109         /// This is used to reconstruct pending outbound payments on restart in the ChannelManager.
2110         ///
2111         /// Currently, the preimage is unused, however if it is present in the relevant internal state
2112         /// an HTLC is always included even if it has been resolved.
2113         pub(crate) fn get_pending_or_resolved_outbound_htlcs(&self) -> HashMap<HTLCSource, (HTLCOutputInCommitment, Option<PaymentPreimage>)> {
2114                 let us = self.inner.lock().unwrap();
2115                 // We're only concerned with the confirmation count of HTLC transactions, and don't
2116                 // actually care how many confirmations a commitment transaction may or may not have. Thus,
2117                 // we look for either a FundingSpendConfirmation event or a funding_spend_confirmed.
2118                 let confirmed_txid = us.funding_spend_confirmed.or_else(|| {
2119                         us.onchain_events_awaiting_threshold_conf.iter().find_map(|event| {
2120                                 if let OnchainEvent::FundingSpendConfirmation { .. } = event.event {
2121                                         Some(event.txid)
2122                                 } else { None }
2123                         })
2124                 });
2125
2126                 if confirmed_txid.is_none() {
2127                         // If we have not seen a commitment transaction on-chain (ie the channel is not yet
2128                         // closed), just get the full set.
2129                         mem::drop(us);
2130                         return self.get_all_current_outbound_htlcs();
2131                 }
2132
2133                 let mut res = HashMap::new();
2134                 macro_rules! walk_htlcs {
2135                         ($holder_commitment: expr, $htlc_iter: expr) => {
2136                                 for (htlc, source) in $htlc_iter {
2137                                         if us.htlcs_resolved_on_chain.iter().any(|v| v.commitment_tx_output_idx == htlc.transaction_output_index) {
2138                                                 // We should assert that funding_spend_confirmed is_some() here, but we
2139                                                 // have some unit tests which violate HTLC transaction CSVs entirely and
2140                                                 // would fail.
2141                                                 // TODO: Once tests all connect transactions at consensus-valid times, we
2142                                                 // should assert here like we do in `get_claimable_balances`.
2143                                         } else if htlc.offered == $holder_commitment {
2144                                                 // If the payment was outbound, check if there's an HTLCUpdate
2145                                                 // indicating we have spent this HTLC with a timeout, claiming it back
2146                                                 // and awaiting confirmations on it.
2147                                                 let htlc_update_confd = us.onchain_events_awaiting_threshold_conf.iter().any(|event| {
2148                                                         if let OnchainEvent::HTLCUpdate { commitment_tx_output_idx: Some(commitment_tx_output_idx), .. } = event.event {
2149                                                                 // If the HTLC was timed out, we wait for ANTI_REORG_DELAY blocks
2150                                                                 // before considering it "no longer pending" - this matches when we
2151                                                                 // provide the ChannelManager an HTLC failure event.
2152                                                                 Some(commitment_tx_output_idx) == htlc.transaction_output_index &&
2153                                                                         us.best_block.height() >= event.height + ANTI_REORG_DELAY - 1
2154                                                         } else if let OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, .. } = event.event {
2155                                                                 // If the HTLC was fulfilled with a preimage, we consider the HTLC
2156                                                                 // immediately non-pending, matching when we provide ChannelManager
2157                                                                 // the preimage.
2158                                                                 Some(commitment_tx_output_idx) == htlc.transaction_output_index
2159                                                         } else { false }
2160                                                 });
2161                                                 let counterparty_resolved_preimage_opt =
2162                                                         us.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).cloned();
2163                                                 if !htlc_update_confd || counterparty_resolved_preimage_opt.is_some() {
2164                                                         res.insert(source.clone(), (htlc.clone(), counterparty_resolved_preimage_opt));
2165                                                 }
2166                                         }
2167                                 }
2168                         }
2169                 }
2170
2171                 let txid = confirmed_txid.unwrap();
2172                 if Some(txid) == us.current_counterparty_commitment_txid || Some(txid) == us.prev_counterparty_commitment_txid {
2173                         walk_htlcs!(false, us.counterparty_claimable_outpoints.get(&txid).unwrap().iter().filter_map(|(a, b)| {
2174                                 if let &Some(ref source) = b {
2175                                         Some((a, &**source))
2176                                 } else { None }
2177                         }));
2178                 } else if txid == us.current_holder_commitment_tx.txid {
2179                         walk_htlcs!(true, us.current_holder_commitment_tx.htlc_outputs.iter().filter_map(|(a, _, c)| {
2180                                 if let Some(source) = c { Some((a, source)) } else { None }
2181                         }));
2182                 } else if let Some(prev_commitment) = &us.prev_holder_signed_commitment_tx {
2183                         if txid == prev_commitment.txid {
2184                                 walk_htlcs!(true, prev_commitment.htlc_outputs.iter().filter_map(|(a, _, c)| {
2185                                         if let Some(source) = c { Some((a, source)) } else { None }
2186                                 }));
2187                         }
2188                 }
2189
2190                 res
2191         }
2192
2193         pub(crate) fn get_stored_preimages(&self) -> HashMap<PaymentHash, PaymentPreimage> {
2194                 self.inner.lock().unwrap().payment_preimages.clone()
2195         }
2196 }
2197
2198 /// Compares a broadcasted commitment transaction's HTLCs with those in the latest state,
2199 /// failing any HTLCs which didn't make it into the broadcasted commitment transaction back
2200 /// after ANTI_REORG_DELAY blocks.
2201 ///
2202 /// We always compare against the set of HTLCs in counterparty commitment transactions, as those
2203 /// are the commitment transactions which are generated by us. The off-chain state machine in
2204 /// `Channel` will automatically resolve any HTLCs which were never included in a commitment
2205 /// transaction when it detects channel closure, but it is up to us to ensure any HTLCs which were
2206 /// included in a remote commitment transaction are failed back if they are not present in the
2207 /// broadcasted commitment transaction.
2208 ///
2209 /// Specifically, the removal process for HTLCs in `Channel` is always based on the counterparty
2210 /// sending a `revoke_and_ack`, which causes us to clear `prev_counterparty_commitment_txid`. Thus,
2211 /// as long as we examine both the current counterparty commitment transaction and, if it hasn't
2212 /// been revoked yet, the previous one, we we will never "forget" to resolve an HTLC.
2213 macro_rules! fail_unbroadcast_htlcs {
2214         ($self: expr, $commitment_tx_type: expr, $commitment_txid_confirmed: expr, $commitment_tx_confirmed: expr,
2215          $commitment_tx_conf_height: expr, $commitment_tx_conf_hash: expr, $confirmed_htlcs_list: expr, $logger: expr) => { {
2216                 debug_assert_eq!($commitment_tx_confirmed.txid(), $commitment_txid_confirmed);
2217
2218                 macro_rules! check_htlc_fails {
2219                         ($txid: expr, $commitment_tx: expr) => {
2220                                 if let Some(ref latest_outpoints) = $self.counterparty_claimable_outpoints.get($txid) {
2221                                         for &(ref htlc, ref source_option) in latest_outpoints.iter() {
2222                                                 if let &Some(ref source) = source_option {
2223                                                         // Check if the HTLC is present in the commitment transaction that was
2224                                                         // broadcast, but not if it was below the dust limit, which we should
2225                                                         // fail backwards immediately as there is no way for us to learn the
2226                                                         // payment_preimage.
2227                                                         // Note that if the dust limit were allowed to change between
2228                                                         // commitment transactions we'd want to be check whether *any*
2229                                                         // broadcastable commitment transaction has the HTLC in it, but it
2230                                                         // cannot currently change after channel initialization, so we don't
2231                                                         // need to here.
2232                                                         let confirmed_htlcs_iter: &mut Iterator<Item = (&HTLCOutputInCommitment, Option<&HTLCSource>)> = &mut $confirmed_htlcs_list;
2233
2234                                                         let mut matched_htlc = false;
2235                                                         for (ref broadcast_htlc, ref broadcast_source) in confirmed_htlcs_iter {
2236                                                                 if broadcast_htlc.transaction_output_index.is_some() &&
2237                                                                         (Some(&**source) == *broadcast_source ||
2238                                                                          (broadcast_source.is_none() &&
2239                                                                           broadcast_htlc.payment_hash == htlc.payment_hash &&
2240                                                                           broadcast_htlc.amount_msat == htlc.amount_msat)) {
2241                                                                         matched_htlc = true;
2242                                                                         break;
2243                                                                 }
2244                                                         }
2245                                                         if matched_htlc { continue; }
2246                                                         if $self.counterparty_fulfilled_htlcs.get(&SentHTLCId::from_source(source)).is_some() {
2247                                                                 continue;
2248                                                         }
2249                                                         $self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
2250                                                                 if entry.height != $commitment_tx_conf_height { return true; }
2251                                                                 match entry.event {
2252                                                                         OnchainEvent::HTLCUpdate { source: ref update_source, .. } => {
2253                                                                                 *update_source != **source
2254                                                                         },
2255                                                                         _ => true,
2256                                                                 }
2257                                                         });
2258                                                         let entry = OnchainEventEntry {
2259                                                                 txid: $commitment_txid_confirmed,
2260                                                                 transaction: Some($commitment_tx_confirmed.clone()),
2261                                                                 height: $commitment_tx_conf_height,
2262                                                                 block_hash: Some(*$commitment_tx_conf_hash),
2263                                                                 event: OnchainEvent::HTLCUpdate {
2264                                                                         source: (**source).clone(),
2265                                                                         payment_hash: htlc.payment_hash.clone(),
2266                                                                         htlc_value_satoshis: Some(htlc.amount_msat / 1000),
2267                                                                         commitment_tx_output_idx: None,
2268                                                                 },
2269                                                         };
2270                                                         log_trace!($logger, "Failing HTLC with payment_hash {} from {} counterparty commitment tx due to broadcast of {} commitment transaction {}, waiting for confirmation (at height {})",
2271                                                                 &htlc.payment_hash, $commitment_tx, $commitment_tx_type,
2272                                                                 $commitment_txid_confirmed, entry.confirmation_threshold());
2273                                                         $self.onchain_events_awaiting_threshold_conf.push(entry);
2274                                                 }
2275                                         }
2276                                 }
2277                         }
2278                 }
2279                 if let Some(ref txid) = $self.current_counterparty_commitment_txid {
2280                         check_htlc_fails!(txid, "current");
2281                 }
2282                 if let Some(ref txid) = $self.prev_counterparty_commitment_txid {
2283                         check_htlc_fails!(txid, "previous");
2284                 }
2285         } }
2286 }
2287
2288 // In the `test_invalid_funding_tx` test, we need a bogus script which matches the HTLC-Accepted
2289 // witness length match (ie is 136 bytes long). We generate one here which we also use in some
2290 // in-line tests later.
2291
2292 #[cfg(test)]
2293 pub fn deliberately_bogus_accepted_htlc_witness_program() -> Vec<u8> {
2294         use bitcoin::blockdata::opcodes;
2295         let mut ret = [opcodes::all::OP_NOP.to_u8(); 136];
2296         ret[131] = opcodes::all::OP_DROP.to_u8();
2297         ret[132] = opcodes::all::OP_DROP.to_u8();
2298         ret[133] = opcodes::all::OP_DROP.to_u8();
2299         ret[134] = opcodes::all::OP_DROP.to_u8();
2300         ret[135] = opcodes::OP_TRUE.to_u8();
2301         Vec::from(&ret[..])
2302 }
2303
2304 #[cfg(test)]
2305 pub fn deliberately_bogus_accepted_htlc_witness() -> Vec<Vec<u8>> {
2306         vec![Vec::new(), Vec::new(), Vec::new(), Vec::new(), deliberately_bogus_accepted_htlc_witness_program().into()].into()
2307 }
2308
2309 impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitorImpl<Signer> {
2310         /// Inserts a revocation secret into this channel monitor. Prunes old preimages if neither
2311         /// needed by holder commitment transactions HTCLs nor by counterparty ones. Unless we haven't already seen
2312         /// counterparty commitment transaction's secret, they are de facto pruned (we can use revocation key).
2313         fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), &'static str> {
2314                 if let Err(()) = self.commitment_secrets.provide_secret(idx, secret) {
2315                         return Err("Previous secret did not match new one");
2316                 }
2317
2318                 // Prune HTLCs from the previous counterparty commitment tx so we don't generate failure/fulfill
2319                 // events for now-revoked/fulfilled HTLCs.
2320                 if let Some(txid) = self.prev_counterparty_commitment_txid.take() {
2321                         if self.current_counterparty_commitment_txid.unwrap() != txid {
2322                                 let cur_claimables = self.counterparty_claimable_outpoints.get(
2323                                         &self.current_counterparty_commitment_txid.unwrap()).unwrap();
2324                                 for (_, ref source_opt) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
2325                                         if let Some(source) = source_opt {
2326                                                 if !cur_claimables.iter()
2327                                                         .any(|(_, cur_source_opt)| cur_source_opt == source_opt)
2328                                                 {
2329                                                         self.counterparty_fulfilled_htlcs.remove(&SentHTLCId::from_source(source));
2330                                                 }
2331                                         }
2332                                 }
2333                                 for &mut (_, ref mut source_opt) in self.counterparty_claimable_outpoints.get_mut(&txid).unwrap() {
2334                                         *source_opt = None;
2335                                 }
2336                         } else {
2337                                 assert!(cfg!(fuzzing), "Commitment txids are unique outside of fuzzing, where hashes can collide");
2338                         }
2339                 }
2340
2341                 if !self.payment_preimages.is_empty() {
2342                         let cur_holder_signed_commitment_tx = &self.current_holder_commitment_tx;
2343                         let prev_holder_signed_commitment_tx = self.prev_holder_signed_commitment_tx.as_ref();
2344                         let min_idx = self.get_min_seen_secret();
2345                         let counterparty_hash_commitment_number = &mut self.counterparty_hash_commitment_number;
2346
2347                         self.payment_preimages.retain(|&k, _| {
2348                                 for &(ref htlc, _, _) in cur_holder_signed_commitment_tx.htlc_outputs.iter() {
2349                                         if k == htlc.payment_hash {
2350                                                 return true
2351                                         }
2352                                 }
2353                                 if let Some(prev_holder_commitment_tx) = prev_holder_signed_commitment_tx {
2354                                         for &(ref htlc, _, _) in prev_holder_commitment_tx.htlc_outputs.iter() {
2355                                                 if k == htlc.payment_hash {
2356                                                         return true
2357                                                 }
2358                                         }
2359                                 }
2360                                 let contains = if let Some(cn) = counterparty_hash_commitment_number.get(&k) {
2361                                         if *cn < min_idx {
2362                                                 return true
2363                                         }
2364                                         true
2365                                 } else { false };
2366                                 if contains {
2367                                         counterparty_hash_commitment_number.remove(&k);
2368                                 }
2369                                 false
2370                         });
2371                 }
2372
2373                 Ok(())
2374         }
2375
2376         pub(crate) fn provide_initial_counterparty_commitment_tx<L: Deref>(
2377                 &mut self, txid: Txid, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
2378                 commitment_number: u64, their_per_commitment_point: PublicKey, feerate_per_kw: u32,
2379                 to_broadcaster_value: u64, to_countersignatory_value: u64, logger: &L
2380         )
2381         where L::Target: Logger
2382         {
2383                 self.initial_counterparty_commitment_info = Some((their_per_commitment_point.clone(),
2384                         feerate_per_kw, to_broadcaster_value, to_countersignatory_value));
2385
2386                 #[cfg(debug_assertions)] {
2387                         let rebuilt_commitment_tx = self.initial_counterparty_commitment_tx().unwrap();
2388                         debug_assert_eq!(rebuilt_commitment_tx.trust().txid(), txid);
2389                 }
2390
2391                 self.provide_latest_counterparty_commitment_tx(txid, htlc_outputs, commitment_number,
2392                                 their_per_commitment_point, logger);
2393         }
2394
2395         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_per_commitment_point: PublicKey, logger: &L) where L::Target: Logger {
2396                 // TODO: Encrypt the htlc_outputs data with the single-hash of the commitment transaction
2397                 // so that a remote monitor doesn't learn anything unless there is a malicious close.
2398                 // (only maybe, sadly we cant do the same for local info, as we need to be aware of
2399                 // timeouts)
2400                 for &(ref htlc, _) in &htlc_outputs {
2401                         self.counterparty_hash_commitment_number.insert(htlc.payment_hash, commitment_number);
2402                 }
2403
2404                 log_trace!(logger, "Tracking new counterparty commitment transaction with txid {} at commitment number {} with {} HTLC outputs", txid, commitment_number, htlc_outputs.len());
2405                 self.prev_counterparty_commitment_txid = self.current_counterparty_commitment_txid.take();
2406                 self.current_counterparty_commitment_txid = Some(txid);
2407                 self.counterparty_claimable_outpoints.insert(txid, htlc_outputs.clone());
2408                 self.current_counterparty_commitment_number = commitment_number;
2409                 //TODO: Merge this into the other per-counterparty-transaction output storage stuff
2410                 match self.their_cur_per_commitment_points {
2411                         Some(old_points) => {
2412                                 if old_points.0 == commitment_number + 1 {
2413                                         self.their_cur_per_commitment_points = Some((old_points.0, old_points.1, Some(their_per_commitment_point)));
2414                                 } else if old_points.0 == commitment_number + 2 {
2415                                         if let Some(old_second_point) = old_points.2 {
2416                                                 self.their_cur_per_commitment_points = Some((old_points.0 - 1, old_second_point, Some(their_per_commitment_point)));
2417                                         } else {
2418                                                 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2419                                         }
2420                                 } else {
2421                                         self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2422                                 }
2423                         },
2424                         None => {
2425                                 self.their_cur_per_commitment_points = Some((commitment_number, their_per_commitment_point, None));
2426                         }
2427                 }
2428                 let mut htlcs = Vec::with_capacity(htlc_outputs.len());
2429                 for htlc in htlc_outputs {
2430                         if htlc.0.transaction_output_index.is_some() {
2431                                 htlcs.push(htlc.0);
2432                         }
2433                 }
2434         }
2435
2436         /// Informs this monitor of the latest holder (ie broadcastable) commitment transaction. The
2437         /// monitor watches for timeouts and may broadcast it if we approach such a timeout. Thus, it
2438         /// is important that any clones of this channel monitor (including remote clones) by kept
2439         /// up-to-date as our holder commitment transaction is updated.
2440         /// Panics if set_on_holder_tx_csv has never been called.
2441         fn provide_latest_holder_commitment_tx(&mut self, holder_commitment_tx: HolderCommitmentTransaction, mut htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>, claimed_htlcs: &[(SentHTLCId, PaymentPreimage)], nondust_htlc_sources: Vec<HTLCSource>) -> Result<(), &'static str> {
2442                 if htlc_outputs.iter().any(|(_, s, _)| s.is_some()) {
2443                         // If we have non-dust HTLCs in htlc_outputs, ensure they match the HTLCs in the
2444                         // `holder_commitment_tx`. In the future, we'll no longer provide the redundant data
2445                         // and just pass in source data via `nondust_htlc_sources`.
2446                         debug_assert_eq!(htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).count(), holder_commitment_tx.trust().htlcs().len());
2447                         for (a, b) in htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).map(|(h, _, _)| h).zip(holder_commitment_tx.trust().htlcs().iter()) {
2448                                 debug_assert_eq!(a, b);
2449                         }
2450                         debug_assert_eq!(htlc_outputs.iter().filter(|(_, s, _)| s.is_some()).count(), holder_commitment_tx.counterparty_htlc_sigs.len());
2451                         for (a, b) in htlc_outputs.iter().filter_map(|(_, s, _)| s.as_ref()).zip(holder_commitment_tx.counterparty_htlc_sigs.iter()) {
2452                                 debug_assert_eq!(a, b);
2453                         }
2454                         debug_assert!(nondust_htlc_sources.is_empty());
2455                 } else {
2456                         // If we don't have any non-dust HTLCs in htlc_outputs, assume they were all passed via
2457                         // `nondust_htlc_sources`, building up the final htlc_outputs by combining
2458                         // `nondust_htlc_sources` and the `holder_commitment_tx`
2459                         #[cfg(debug_assertions)] {
2460                                 let mut prev = -1;
2461                                 for htlc in holder_commitment_tx.trust().htlcs().iter() {
2462                                         assert!(htlc.transaction_output_index.unwrap() as i32 > prev);
2463                                         prev = htlc.transaction_output_index.unwrap() as i32;
2464                                 }
2465                         }
2466                         debug_assert!(htlc_outputs.iter().all(|(htlc, _, _)| htlc.transaction_output_index.is_none()));
2467                         debug_assert!(htlc_outputs.iter().all(|(_, sig_opt, _)| sig_opt.is_none()));
2468                         debug_assert_eq!(holder_commitment_tx.trust().htlcs().len(), holder_commitment_tx.counterparty_htlc_sigs.len());
2469
2470                         let mut sources_iter = nondust_htlc_sources.into_iter();
2471
2472                         for (htlc, counterparty_sig) in holder_commitment_tx.trust().htlcs().iter()
2473                                 .zip(holder_commitment_tx.counterparty_htlc_sigs.iter())
2474                         {
2475                                 if htlc.offered {
2476                                         let source = sources_iter.next().expect("Non-dust HTLC sources didn't match commitment tx");
2477                                         #[cfg(debug_assertions)] {
2478                                                 assert!(source.possibly_matches_output(htlc));
2479                                         }
2480                                         htlc_outputs.push((htlc.clone(), Some(counterparty_sig.clone()), Some(source)));
2481                                 } else {
2482                                         htlc_outputs.push((htlc.clone(), Some(counterparty_sig.clone()), None));
2483                                 }
2484                         }
2485                         debug_assert!(sources_iter.next().is_none());
2486                 }
2487
2488                 let trusted_tx = holder_commitment_tx.trust();
2489                 let txid = trusted_tx.txid();
2490                 let tx_keys = trusted_tx.keys();
2491                 self.current_holder_commitment_number = trusted_tx.commitment_number();
2492                 let mut new_holder_commitment_tx = HolderSignedTx {
2493                         txid,
2494                         revocation_key: tx_keys.revocation_key,
2495                         a_htlc_key: tx_keys.broadcaster_htlc_key,
2496                         b_htlc_key: tx_keys.countersignatory_htlc_key,
2497                         delayed_payment_key: tx_keys.broadcaster_delayed_payment_key,
2498                         per_commitment_point: tx_keys.per_commitment_point,
2499                         htlc_outputs,
2500                         to_self_value_sat: holder_commitment_tx.to_broadcaster_value_sat(),
2501                         feerate_per_kw: trusted_tx.feerate_per_kw(),
2502                 };
2503                 self.onchain_tx_handler.provide_latest_holder_tx(holder_commitment_tx);
2504                 mem::swap(&mut new_holder_commitment_tx, &mut self.current_holder_commitment_tx);
2505                 self.prev_holder_signed_commitment_tx = Some(new_holder_commitment_tx);
2506                 for (claimed_htlc_id, claimed_preimage) in claimed_htlcs {
2507                         #[cfg(debug_assertions)] {
2508                                 let cur_counterparty_htlcs = self.counterparty_claimable_outpoints.get(
2509                                                 &self.current_counterparty_commitment_txid.unwrap()).unwrap();
2510                                 assert!(cur_counterparty_htlcs.iter().any(|(_, source_opt)| {
2511                                         if let Some(source) = source_opt {
2512                                                 SentHTLCId::from_source(source) == *claimed_htlc_id
2513                                         } else { false }
2514                                 }));
2515                         }
2516                         self.counterparty_fulfilled_htlcs.insert(*claimed_htlc_id, *claimed_preimage);
2517                 }
2518                 if self.holder_tx_signed {
2519                         return Err("Latest holder commitment signed has already been signed, update is rejected");
2520                 }
2521                 Ok(())
2522         }
2523
2524         /// Provides a payment_hash->payment_preimage mapping. Will be automatically pruned when all
2525         /// commitment_tx_infos which contain the payment hash have been revoked.
2526         fn provide_payment_preimage<B: Deref, F: Deref, L: Deref>(
2527                 &mut self, payment_hash: &PaymentHash, payment_preimage: &PaymentPreimage, broadcaster: &B,
2528                 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L)
2529         where B::Target: BroadcasterInterface,
2530                     F::Target: FeeEstimator,
2531                     L::Target: Logger,
2532         {
2533                 self.payment_preimages.insert(payment_hash.clone(), payment_preimage.clone());
2534
2535                 let confirmed_spend_txid = self.funding_spend_confirmed.or_else(|| {
2536                         self.onchain_events_awaiting_threshold_conf.iter().find_map(|event| match event.event {
2537                                 OnchainEvent::FundingSpendConfirmation { .. } => Some(event.txid),
2538                                 _ => None,
2539                         })
2540                 });
2541                 let confirmed_spend_txid = if let Some(txid) = confirmed_spend_txid {
2542                         txid
2543                 } else {
2544                         return;
2545                 };
2546
2547                 // If the channel is force closed, try to claim the output from this preimage.
2548                 // First check if a counterparty commitment transaction has been broadcasted:
2549                 macro_rules! claim_htlcs {
2550                         ($commitment_number: expr, $txid: expr) => {
2551                                 let (htlc_claim_reqs, _) = self.get_counterparty_output_claim_info($commitment_number, $txid, None);
2552                                 self.onchain_tx_handler.update_claims_view_from_requests(htlc_claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2553                         }
2554                 }
2555                 if let Some(txid) = self.current_counterparty_commitment_txid {
2556                         if txid == confirmed_spend_txid {
2557                                 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
2558                                         claim_htlcs!(*commitment_number, txid);
2559                                 } else {
2560                                         debug_assert!(false);
2561                                         log_error!(logger, "Detected counterparty commitment tx on-chain without tracking commitment number");
2562                                 }
2563                                 return;
2564                         }
2565                 }
2566                 if let Some(txid) = self.prev_counterparty_commitment_txid {
2567                         if txid == confirmed_spend_txid {
2568                                 if let Some(commitment_number) = self.counterparty_commitment_txn_on_chain.get(&txid) {
2569                                         claim_htlcs!(*commitment_number, txid);
2570                                 } else {
2571                                         debug_assert!(false);
2572                                         log_error!(logger, "Detected counterparty commitment tx on-chain without tracking commitment number");
2573                                 }
2574                                 return;
2575                         }
2576                 }
2577
2578                 // Then if a holder commitment transaction has been seen on-chain, broadcast transactions
2579                 // claiming the HTLC output from each of the holder commitment transactions.
2580                 // Note that we can't just use `self.holder_tx_signed`, because that only covers the case where
2581                 // *we* sign a holder commitment transaction, not when e.g. a watchtower broadcasts one of our
2582                 // holder commitment transactions.
2583                 if self.broadcasted_holder_revokable_script.is_some() {
2584                         let holder_commitment_tx = if self.current_holder_commitment_tx.txid == confirmed_spend_txid {
2585                                 Some(&self.current_holder_commitment_tx)
2586                         } else if let Some(prev_holder_commitment_tx) = &self.prev_holder_signed_commitment_tx {
2587                                 if prev_holder_commitment_tx.txid == confirmed_spend_txid {
2588                                         Some(prev_holder_commitment_tx)
2589                                 } else {
2590                                         None
2591                                 }
2592                         } else {
2593                                 None
2594                         };
2595                         if let Some(holder_commitment_tx) = holder_commitment_tx {
2596                                 // Assume that the broadcasted commitment transaction confirmed in the current best
2597                                 // block. Even if not, its a reasonable metric for the bump criteria on the HTLC
2598                                 // transactions.
2599                                 let (claim_reqs, _) = self.get_broadcasted_holder_claims(&holder_commitment_tx, self.best_block.height());
2600                                 self.onchain_tx_handler.update_claims_view_from_requests(claim_reqs, self.best_block.height(), self.best_block.height(), broadcaster, fee_estimator, logger);
2601                         }
2602                 }
2603         }
2604
2605         pub(crate) fn broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(&mut self, broadcaster: &B, logger: &L)
2606                 where B::Target: BroadcasterInterface,
2607                                         L::Target: Logger,
2608         {
2609                 let commit_txs = self.get_latest_holder_commitment_txn(logger);
2610                 let mut txs = vec![];
2611                 for tx in commit_txs.iter() {
2612                         log_info!(logger, "Broadcasting local {}", log_tx!(tx));
2613                         txs.push(tx);
2614                 }
2615                 broadcaster.broadcast_transactions(&txs);
2616                 self.pending_monitor_events.push(MonitorEvent::HolderForceClosed(self.funding_info.0));
2617         }
2618
2619         pub fn update_monitor<B: Deref, F: Deref, L: Deref>(&mut self, updates: &ChannelMonitorUpdate, broadcaster: &B, fee_estimator: &F, logger: &L) -> Result<(), ()>
2620         where B::Target: BroadcasterInterface,
2621                 F::Target: FeeEstimator,
2622                 L::Target: Logger,
2623         {
2624                 if self.latest_update_id == CLOSED_CHANNEL_UPDATE_ID && updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2625                         log_info!(logger, "Applying post-force-closed update to monitor {} with {} change(s).",
2626                                 log_funding_info!(self), updates.updates.len());
2627                 } else if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2628                         log_info!(logger, "Applying force close update to monitor {} with {} change(s).",
2629                                 log_funding_info!(self), updates.updates.len());
2630                 } else {
2631                         log_info!(logger, "Applying update to monitor {}, bringing update_id from {} to {} with {} change(s).",
2632                                 log_funding_info!(self), self.latest_update_id, updates.update_id, updates.updates.len());
2633                 }
2634                 // ChannelMonitor updates may be applied after force close if we receive a preimage for a
2635                 // broadcasted commitment transaction HTLC output that we'd like to claim on-chain. If this
2636                 // is the case, we no longer have guaranteed access to the monitor's update ID, so we use a
2637                 // sentinel value instead.
2638                 //
2639                 // The `ChannelManager` may also queue redundant `ChannelForceClosed` updates if it still
2640                 // thinks the channel needs to have its commitment transaction broadcast, so we'll allow
2641                 // them as well.
2642                 if updates.update_id == CLOSED_CHANNEL_UPDATE_ID {
2643                         assert_eq!(updates.updates.len(), 1);
2644                         match updates.updates[0] {
2645                                 ChannelMonitorUpdateStep::ChannelForceClosed { .. } => {},
2646                                 // We should have already seen a `ChannelForceClosed` update if we're trying to
2647                                 // provide a preimage at this point.
2648                                 ChannelMonitorUpdateStep::PaymentPreimage { .. } =>
2649                                         debug_assert_eq!(self.latest_update_id, CLOSED_CHANNEL_UPDATE_ID),
2650                                 _ => {
2651                                         log_error!(logger, "Attempted to apply post-force-close ChannelMonitorUpdate of type {}", updates.updates[0].variant_name());
2652                                         panic!("Attempted to apply post-force-close ChannelMonitorUpdate that wasn't providing a payment preimage");
2653                                 },
2654                         }
2655                 } else if self.latest_update_id + 1 != updates.update_id {
2656                         panic!("Attempted to apply ChannelMonitorUpdates out of order, check the update_id before passing an update to update_monitor!");
2657                 }
2658                 let mut ret = Ok(());
2659                 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&**fee_estimator);
2660                 for update in updates.updates.iter() {
2661                         match update {
2662                                 ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo { commitment_tx, htlc_outputs, claimed_htlcs, nondust_htlc_sources } => {
2663                                         log_trace!(logger, "Updating ChannelMonitor with latest holder commitment transaction info");
2664                                         if self.lockdown_from_offchain { panic!(); }
2665                                         if let Err(e) = self.provide_latest_holder_commitment_tx(commitment_tx.clone(), htlc_outputs.clone(), &claimed_htlcs, nondust_htlc_sources.clone()) {
2666                                                 log_error!(logger, "Providing latest holder commitment transaction failed/was refused:");
2667                                                 log_error!(logger, "    {}", e);
2668                                                 ret = Err(());
2669                                         }
2670                                 }
2671                                 ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid, htlc_outputs, commitment_number, their_per_commitment_point, .. } => {
2672                                         log_trace!(logger, "Updating ChannelMonitor with latest counterparty commitment transaction info");
2673                                         self.provide_latest_counterparty_commitment_tx(*commitment_txid, htlc_outputs.clone(), *commitment_number, *their_per_commitment_point, logger)
2674                                 },
2675                                 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } => {
2676                                         log_trace!(logger, "Updating ChannelMonitor with payment preimage");
2677                                         self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage, broadcaster, &bounded_fee_estimator, logger)
2678                                 },
2679                                 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } => {
2680                                         log_trace!(logger, "Updating ChannelMonitor with commitment secret");
2681                                         if let Err(e) = self.provide_secret(*idx, *secret) {
2682                                                 debug_assert!(false, "Latest counterparty commitment secret was invalid");
2683                                                 log_error!(logger, "Providing latest counterparty commitment secret failed/was refused:");
2684                                                 log_error!(logger, "    {}", e);
2685                                                 ret = Err(());
2686                                         }
2687                                 },
2688                                 ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } => {
2689                                         log_trace!(logger, "Updating ChannelMonitor: channel force closed, should broadcast: {}", should_broadcast);
2690                                         self.lockdown_from_offchain = true;
2691                                         if *should_broadcast {
2692                                                 // There's no need to broadcast our commitment transaction if we've seen one
2693                                                 // confirmed (even with 1 confirmation) as it'll be rejected as
2694                                                 // duplicate/conflicting.
2695                                                 let detected_funding_spend = self.funding_spend_confirmed.is_some() ||
2696                                                         self.onchain_events_awaiting_threshold_conf.iter().find(|event| match event.event {
2697                                                                 OnchainEvent::FundingSpendConfirmation { .. } => true,
2698                                                                 _ => false,
2699                                                         }).is_some();
2700                                                 if detected_funding_spend {
2701                                                         log_trace!(logger, "Avoiding commitment broadcast, already detected confirmed spend onchain");
2702                                                         continue;
2703                                                 }
2704                                                 self.broadcast_latest_holder_commitment_txn(broadcaster, logger);
2705                                                 // If the channel supports anchor outputs, we'll need to emit an external
2706                                                 // event to be consumed such that a child transaction is broadcast with a
2707                                                 // high enough feerate for the parent commitment transaction to confirm.
2708                                                 if self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
2709                                                         let funding_output = HolderFundingOutput::build(
2710                                                                 self.funding_redeemscript.clone(), self.channel_value_satoshis,
2711                                                                 self.onchain_tx_handler.channel_type_features().clone(),
2712                                                         );
2713                                                         let best_block_height = self.best_block.height();
2714                                                         let commitment_package = PackageTemplate::build_package(
2715                                                                 self.funding_info.0.txid.clone(), self.funding_info.0.index as u32,
2716                                                                 PackageSolvingData::HolderFundingOutput(funding_output),
2717                                                                 best_block_height, best_block_height
2718                                                         );
2719                                                         self.onchain_tx_handler.update_claims_view_from_requests(
2720                                                                 vec![commitment_package], best_block_height, best_block_height,
2721                                                                 broadcaster, &bounded_fee_estimator, logger,
2722                                                         );
2723                                                 }
2724                                         } else if !self.holder_tx_signed {
2725                                                 log_error!(logger, "WARNING: You have a potentially-unsafe holder commitment transaction available to broadcast");
2726                                                 log_error!(logger, "    in channel monitor for channel {}!", &self.funding_info.0.to_channel_id());
2727                                                 log_error!(logger, "    Read the docs for ChannelMonitor::get_latest_holder_commitment_txn and take manual action!");
2728                                         } else {
2729                                                 // If we generated a MonitorEvent::HolderForceClosed, the ChannelManager
2730                                                 // will still give us a ChannelForceClosed event with !should_broadcast, but we
2731                                                 // shouldn't print the scary warning above.
2732                                                 log_info!(logger, "Channel off-chain state closed after we broadcasted our latest commitment transaction.");
2733                                         }
2734                                 },
2735                                 ChannelMonitorUpdateStep::ShutdownScript { scriptpubkey } => {
2736                                         log_trace!(logger, "Updating ChannelMonitor with shutdown script");
2737                                         if let Some(shutdown_script) = self.shutdown_script.replace(scriptpubkey.clone()) {
2738                                                 panic!("Attempted to replace shutdown script {} with {}", shutdown_script, scriptpubkey);
2739                                         }
2740                                 },
2741                         }
2742                 }
2743
2744                 #[cfg(debug_assertions)] {
2745                         self.counterparty_commitment_txs_from_update(updates);
2746                 }
2747
2748                 // If the updates succeeded and we were in an already closed channel state, then there's no
2749                 // need to refuse any updates we expect to receive afer seeing a confirmed commitment.
2750                 if ret.is_ok() && updates.update_id == CLOSED_CHANNEL_UPDATE_ID && self.latest_update_id == updates.update_id {
2751                         return Ok(());
2752                 }
2753
2754                 self.latest_update_id = updates.update_id;
2755
2756                 // Refuse updates after we've detected a spend onchain, but only if we haven't processed a
2757                 // force closed monitor update yet.
2758                 if ret.is_ok() && self.funding_spend_seen && self.latest_update_id != CLOSED_CHANNEL_UPDATE_ID {
2759                         log_error!(logger, "Refusing Channel Monitor Update as counterparty attempted to update commitment after funding was spent");
2760                         Err(())
2761                 } else { ret }
2762         }
2763
2764         pub fn get_latest_update_id(&self) -> u64 {
2765                 self.latest_update_id
2766         }
2767
2768         pub fn get_funding_txo(&self) -> &(OutPoint, Script) {
2769                 &self.funding_info
2770         }
2771
2772         pub fn get_outputs_to_watch(&self) -> &HashMap<Txid, Vec<(u32, Script)>> {
2773                 // If we've detected a counterparty commitment tx on chain, we must include it in the set
2774                 // of outputs to watch for spends of, otherwise we're likely to lose user funds. Because
2775                 // its trivial to do, double-check that here.
2776                 for (txid, _) in self.counterparty_commitment_txn_on_chain.iter() {
2777                         self.outputs_to_watch.get(txid).expect("Counterparty commitment txn which have been broadcast should have outputs registered");
2778                 }
2779                 &self.outputs_to_watch
2780         }
2781
2782         pub fn get_and_clear_pending_monitor_events(&mut self) -> Vec<MonitorEvent> {
2783                 let mut ret = Vec::new();
2784                 mem::swap(&mut ret, &mut self.pending_monitor_events);
2785                 ret
2786         }
2787
2788         /// Gets the set of events that are repeated regularly (e.g. those which RBF bump
2789         /// transactions). We're okay if we lose these on restart as they'll be regenerated for us at
2790         /// some regular interval via [`ChannelMonitor::rebroadcast_pending_claims`].
2791         pub(super) fn get_repeated_events(&mut self) -> Vec<Event> {
2792                 let pending_claim_events = self.onchain_tx_handler.get_and_clear_pending_claim_events();
2793                 let mut ret = Vec::with_capacity(pending_claim_events.len());
2794                 for (claim_id, claim_event) in pending_claim_events {
2795                         match claim_event {
2796                                 ClaimEvent::BumpCommitment {
2797                                         package_target_feerate_sat_per_1000_weight, commitment_tx, anchor_output_idx,
2798                                 } => {
2799                                         let commitment_txid = commitment_tx.txid();
2800                                         debug_assert_eq!(self.current_holder_commitment_tx.txid, commitment_txid);
2801                                         let pending_htlcs = self.current_holder_commitment_tx.non_dust_htlcs();
2802                                         let commitment_tx_fee_satoshis = self.channel_value_satoshis -
2803                                                 commitment_tx.output.iter().fold(0u64, |sum, output| sum + output.value);
2804                                         ret.push(Event::BumpTransaction(BumpTransactionEvent::ChannelClose {
2805                                                 claim_id,
2806                                                 package_target_feerate_sat_per_1000_weight,
2807                                                 commitment_tx,
2808                                                 commitment_tx_fee_satoshis,
2809                                                 anchor_descriptor: AnchorDescriptor {
2810                                                         channel_derivation_parameters: ChannelDerivationParameters {
2811                                                                 keys_id: self.channel_keys_id,
2812                                                                 value_satoshis: self.channel_value_satoshis,
2813                                                                 transaction_parameters: self.onchain_tx_handler.channel_transaction_parameters.clone(),
2814                                                         },
2815                                                         outpoint: BitcoinOutPoint {
2816                                                                 txid: commitment_txid,
2817                                                                 vout: anchor_output_idx,
2818                                                         },
2819                                                 },
2820                                                 pending_htlcs,
2821                                         }));
2822                                 },
2823                                 ClaimEvent::BumpHTLC {
2824                                         target_feerate_sat_per_1000_weight, htlcs, tx_lock_time,
2825                                 } => {
2826                                         let mut htlc_descriptors = Vec::with_capacity(htlcs.len());
2827                                         for htlc in htlcs {
2828                                                 htlc_descriptors.push(HTLCDescriptor {
2829                                                         channel_derivation_parameters: ChannelDerivationParameters {
2830                                                                 keys_id: self.channel_keys_id,
2831                                                                 value_satoshis: self.channel_value_satoshis,
2832                                                                 transaction_parameters: self.onchain_tx_handler.channel_transaction_parameters.clone(),
2833                                                         },
2834                                                         commitment_txid: htlc.commitment_txid,
2835                                                         per_commitment_number: htlc.per_commitment_number,
2836                                                         per_commitment_point: self.onchain_tx_handler.signer.get_per_commitment_point(
2837                                                                 htlc.per_commitment_number, &self.onchain_tx_handler.secp_ctx,
2838                                                         ),
2839                                                         htlc: htlc.htlc,
2840                                                         preimage: htlc.preimage,
2841                                                         counterparty_sig: htlc.counterparty_sig,
2842                                                 });
2843                                         }
2844                                         ret.push(Event::BumpTransaction(BumpTransactionEvent::HTLCResolution {
2845                                                 claim_id,
2846                                                 target_feerate_sat_per_1000_weight,
2847                                                 htlc_descriptors,
2848                                                 tx_lock_time,
2849                                         }));
2850                                 }
2851                         }
2852                 }
2853                 ret
2854         }
2855
2856         pub(crate) fn initial_counterparty_commitment_tx(&mut self) -> Option<CommitmentTransaction> {
2857                 let (their_per_commitment_point, feerate_per_kw, to_broadcaster_value,
2858                         to_countersignatory_value) = self.initial_counterparty_commitment_info?;
2859                 let htlc_outputs = vec![];
2860
2861                 let commitment_tx = self.build_counterparty_commitment_tx(INITIAL_COMMITMENT_NUMBER,
2862                         &their_per_commitment_point, to_broadcaster_value, to_countersignatory_value,
2863                         feerate_per_kw, htlc_outputs);
2864                 Some(commitment_tx)
2865         }
2866
2867         fn build_counterparty_commitment_tx(
2868                 &self, commitment_number: u64, their_per_commitment_point: &PublicKey,
2869                 to_broadcaster_value: u64, to_countersignatory_value: u64, feerate_per_kw: u32,
2870                 mut nondust_htlcs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>
2871         ) -> CommitmentTransaction {
2872                 let broadcaster_keys = &self.onchain_tx_handler.channel_transaction_parameters
2873                         .counterparty_parameters.as_ref().unwrap().pubkeys;
2874                 let countersignatory_keys =
2875                         &self.onchain_tx_handler.channel_transaction_parameters.holder_pubkeys;
2876
2877                 let broadcaster_funding_key = broadcaster_keys.funding_pubkey;
2878                 let countersignatory_funding_key = countersignatory_keys.funding_pubkey;
2879                 let keys = TxCreationKeys::from_channel_static_keys(&their_per_commitment_point,
2880                         &broadcaster_keys, &countersignatory_keys, &self.onchain_tx_handler.secp_ctx);
2881                 let channel_parameters =
2882                         &self.onchain_tx_handler.channel_transaction_parameters.as_counterparty_broadcastable();
2883
2884                 CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
2885                         to_broadcaster_value, to_countersignatory_value, broadcaster_funding_key,
2886                         countersignatory_funding_key, keys, feerate_per_kw, &mut nondust_htlcs,
2887                         channel_parameters)
2888         }
2889
2890         pub(crate) fn counterparty_commitment_txs_from_update(&self, update: &ChannelMonitorUpdate) -> Vec<CommitmentTransaction> {
2891                 update.updates.iter().filter_map(|update| {
2892                         match update {
2893                                 &ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { commitment_txid,
2894                                         ref htlc_outputs, commitment_number, their_per_commitment_point,
2895                                         feerate_per_kw: Some(feerate_per_kw),
2896                                         to_broadcaster_value_sat: Some(to_broadcaster_value),
2897                                         to_countersignatory_value_sat: Some(to_countersignatory_value) } => {
2898
2899                                         let nondust_htlcs = htlc_outputs.iter().filter_map(|(htlc, _)| {
2900                                                 htlc.transaction_output_index.map(|_| (htlc.clone(), None))
2901                                         }).collect::<Vec<_>>();
2902
2903                                         let commitment_tx = self.build_counterparty_commitment_tx(commitment_number,
2904                                                         &their_per_commitment_point, to_broadcaster_value,
2905                                                         to_countersignatory_value, feerate_per_kw, nondust_htlcs);
2906
2907                                         debug_assert_eq!(commitment_tx.trust().txid(), commitment_txid);
2908
2909                                         Some(commitment_tx)
2910                                 },
2911                                 _ => None,
2912                         }
2913                 }).collect()
2914         }
2915
2916         pub(crate) fn sign_to_local_justice_tx(
2917                 &self, mut justice_tx: Transaction, input_idx: usize, value: u64, commitment_number: u64
2918         ) -> Result<Transaction, ()> {
2919                 let secret = self.get_secret(commitment_number).ok_or(())?;
2920                 let per_commitment_key = SecretKey::from_slice(&secret).map_err(|_| ())?;
2921                 let their_per_commitment_point = PublicKey::from_secret_key(
2922                         &self.onchain_tx_handler.secp_ctx, &per_commitment_key);
2923
2924                 let revocation_pubkey = chan_utils::derive_public_revocation_key(
2925                         &self.onchain_tx_handler.secp_ctx, &their_per_commitment_point,
2926                         &self.holder_revocation_basepoint);
2927                 let delayed_key = chan_utils::derive_public_key(&self.onchain_tx_handler.secp_ctx,
2928                         &their_per_commitment_point,
2929                         &self.counterparty_commitment_params.counterparty_delayed_payment_base_key);
2930                 let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey,
2931                         self.counterparty_commitment_params.on_counterparty_tx_csv, &delayed_key);
2932
2933                 let sig = self.onchain_tx_handler.signer.sign_justice_revoked_output(
2934                         &justice_tx, input_idx, value, &per_commitment_key, &self.onchain_tx_handler.secp_ctx)?;
2935                 justice_tx.input[input_idx].witness.push_bitcoin_signature(&sig.serialize_der(), EcdsaSighashType::All);
2936                 justice_tx.input[input_idx].witness.push(&[1u8]);
2937                 justice_tx.input[input_idx].witness.push(revokeable_redeemscript.as_bytes());
2938                 Ok(justice_tx)
2939         }
2940
2941         /// Can only fail if idx is < get_min_seen_secret
2942         fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
2943                 self.commitment_secrets.get_secret(idx)
2944         }
2945
2946         pub(crate) fn get_min_seen_secret(&self) -> u64 {
2947                 self.commitment_secrets.get_min_seen_secret()
2948         }
2949
2950         pub(crate) fn get_cur_counterparty_commitment_number(&self) -> u64 {
2951                 self.current_counterparty_commitment_number
2952         }
2953
2954         pub(crate) fn get_cur_holder_commitment_number(&self) -> u64 {
2955                 self.current_holder_commitment_number
2956         }
2957
2958         /// Attempts to claim a counterparty commitment transaction's outputs using the revocation key and
2959         /// data in counterparty_claimable_outpoints. Will directly claim any HTLC outputs which expire at a
2960         /// height > height + CLTV_SHARED_CLAIM_BUFFER. In any case, will install monitoring for
2961         /// HTLC-Success/HTLC-Timeout transactions.
2962         ///
2963         /// Returns packages to claim the revoked output(s), as well as additional outputs to watch and
2964         /// general information about the output that is to the counterparty in the commitment
2965         /// transaction.
2966         fn check_spend_counterparty_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L)
2967                 -> (Vec<PackageTemplate>, TransactionOutputs, CommitmentTxCounterpartyOutputInfo)
2968         where L::Target: Logger {
2969                 // Most secp and related errors trying to create keys means we have no hope of constructing
2970                 // a spend transaction...so we return no transactions to broadcast
2971                 let mut claimable_outpoints = Vec::new();
2972                 let mut watch_outputs = Vec::new();
2973                 let mut to_counterparty_output_info = None;
2974
2975                 let commitment_txid = tx.txid(); //TODO: This is gonna be a performance bottleneck for watchtowers!
2976                 let per_commitment_option = self.counterparty_claimable_outpoints.get(&commitment_txid);
2977
2978                 macro_rules! ignore_error {
2979                         ( $thing : expr ) => {
2980                                 match $thing {
2981                                         Ok(a) => a,
2982                                         Err(_) => return (claimable_outpoints, (commitment_txid, watch_outputs), to_counterparty_output_info)
2983                                 }
2984                         };
2985                 }
2986
2987                 let commitment_number = 0xffffffffffff - ((((tx.input[0].sequence.0 as u64 & 0xffffff) << 3*8) | (tx.lock_time.0 as u64 & 0xffffff)) ^ self.commitment_transaction_number_obscure_factor);
2988                 if commitment_number >= self.get_min_seen_secret() {
2989                         let secret = self.get_secret(commitment_number).unwrap();
2990                         let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
2991                         let per_commitment_point = PublicKey::from_secret_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_key);
2992                         let revocation_pubkey = chan_utils::derive_public_revocation_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint);
2993                         let delayed_key = chan_utils::derive_public_key(&self.onchain_tx_handler.secp_ctx, &PublicKey::from_secret_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_key), &self.counterparty_commitment_params.counterparty_delayed_payment_base_key);
2994
2995                         let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.counterparty_commitment_params.on_counterparty_tx_csv, &delayed_key);
2996                         let revokeable_p2wsh = revokeable_redeemscript.to_v0_p2wsh();
2997
2998                         // First, process non-htlc outputs (to_holder & to_counterparty)
2999                         for (idx, outp) in tx.output.iter().enumerate() {
3000                                 if outp.script_pubkey == revokeable_p2wsh {
3001                                         let revk_outp = RevokedOutput::build(per_commitment_point, self.counterparty_commitment_params.counterparty_delayed_payment_base_key, self.counterparty_commitment_params.counterparty_htlc_base_key, per_commitment_key, outp.value, self.counterparty_commitment_params.on_counterparty_tx_csv, self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx());
3002                                         let justice_package = PackageTemplate::build_package(commitment_txid, idx as u32, PackageSolvingData::RevokedOutput(revk_outp), height + self.counterparty_commitment_params.on_counterparty_tx_csv as u32, height);
3003                                         claimable_outpoints.push(justice_package);
3004                                         to_counterparty_output_info =
3005                                                 Some((idx.try_into().expect("Txn can't have more than 2^32 outputs"), outp.value));
3006                                 }
3007                         }
3008
3009                         // Then, try to find revoked htlc outputs
3010                         if let Some(ref per_commitment_data) = per_commitment_option {
3011                                 for (_, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
3012                                         if let Some(transaction_output_index) = htlc.transaction_output_index {
3013                                                 if transaction_output_index as usize >= tx.output.len() ||
3014                                                                 tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
3015                                                         // per_commitment_data is corrupt or our commitment signing key leaked!
3016                                                         return (claimable_outpoints, (commitment_txid, watch_outputs),
3017                                                                 to_counterparty_output_info);
3018                                                 }
3019                                                 let revk_htlc_outp = RevokedHTLCOutput::build(per_commitment_point, self.counterparty_commitment_params.counterparty_delayed_payment_base_key, self.counterparty_commitment_params.counterparty_htlc_base_key, per_commitment_key, htlc.amount_msat / 1000, htlc.clone(), &self.onchain_tx_handler.channel_transaction_parameters.channel_type_features);
3020                                                 let justice_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, PackageSolvingData::RevokedHTLCOutput(revk_htlc_outp), htlc.cltv_expiry, height);
3021                                                 claimable_outpoints.push(justice_package);
3022                                         }
3023                                 }
3024                         }
3025
3026                         // Last, track onchain revoked commitment transaction and fail backward outgoing HTLCs as payment path is broken
3027                         if !claimable_outpoints.is_empty() || per_commitment_option.is_some() { // ie we're confident this is actually ours
3028                                 // We're definitely a counterparty commitment transaction!
3029                                 log_error!(logger, "Got broadcast of revoked counterparty commitment transaction, going to generate general spend tx with {} inputs", claimable_outpoints.len());
3030                                 for (idx, outp) in tx.output.iter().enumerate() {
3031                                         watch_outputs.push((idx as u32, outp.clone()));
3032                                 }
3033                                 self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
3034
3035                                 if let Some(per_commitment_data) = per_commitment_option {
3036                                         fail_unbroadcast_htlcs!(self, "revoked_counterparty", commitment_txid, tx, height,
3037                                                 block_hash, per_commitment_data.iter().map(|(htlc, htlc_source)|
3038                                                         (htlc, htlc_source.as_ref().map(|htlc_source| htlc_source.as_ref()))
3039                                                 ), logger);
3040                                 } else {
3041                                         debug_assert!(false, "We should have per-commitment option for any recognized old commitment txn");
3042                                         fail_unbroadcast_htlcs!(self, "revoked counterparty", commitment_txid, tx, height,
3043                                                 block_hash, [].iter().map(|reference| *reference), logger);
3044                                 }
3045                         }
3046                 } else if let Some(per_commitment_data) = per_commitment_option {
3047                         // While this isn't useful yet, there is a potential race where if a counterparty
3048                         // revokes a state at the same time as the commitment transaction for that state is
3049                         // confirmed, and the watchtower receives the block before the user, the user could
3050                         // upload a new ChannelMonitor with the revocation secret but the watchtower has
3051                         // already processed the block, resulting in the counterparty_commitment_txn_on_chain entry
3052                         // not being generated by the above conditional. Thus, to be safe, we go ahead and
3053                         // insert it here.
3054                         for (idx, outp) in tx.output.iter().enumerate() {
3055                                 watch_outputs.push((idx as u32, outp.clone()));
3056                         }
3057                         self.counterparty_commitment_txn_on_chain.insert(commitment_txid, commitment_number);
3058
3059                         log_info!(logger, "Got broadcast of non-revoked counterparty commitment transaction {}", commitment_txid);
3060                         fail_unbroadcast_htlcs!(self, "counterparty", commitment_txid, tx, height, block_hash,
3061                                 per_commitment_data.iter().map(|(htlc, htlc_source)|
3062                                         (htlc, htlc_source.as_ref().map(|htlc_source| htlc_source.as_ref()))
3063                                 ), logger);
3064
3065                         let (htlc_claim_reqs, counterparty_output_info) =
3066                                 self.get_counterparty_output_claim_info(commitment_number, commitment_txid, Some(tx));
3067                         to_counterparty_output_info = counterparty_output_info;
3068                         for req in htlc_claim_reqs {
3069                                 claimable_outpoints.push(req);
3070                         }
3071
3072                 }
3073                 (claimable_outpoints, (commitment_txid, watch_outputs), to_counterparty_output_info)
3074         }
3075
3076         /// Returns the HTLC claim package templates and the counterparty output info
3077         fn get_counterparty_output_claim_info(&self, commitment_number: u64, commitment_txid: Txid, tx: Option<&Transaction>)
3078         -> (Vec<PackageTemplate>, CommitmentTxCounterpartyOutputInfo) {
3079                 let mut claimable_outpoints = Vec::new();
3080                 let mut to_counterparty_output_info: CommitmentTxCounterpartyOutputInfo = None;
3081
3082                 let htlc_outputs = match self.counterparty_claimable_outpoints.get(&commitment_txid) {
3083                         Some(outputs) => outputs,
3084                         None => return (claimable_outpoints, to_counterparty_output_info),
3085                 };
3086                 let per_commitment_points = match self.their_cur_per_commitment_points {
3087                         Some(points) => points,
3088                         None => return (claimable_outpoints, to_counterparty_output_info),
3089                 };
3090
3091                 let per_commitment_point =
3092                         // If the counterparty commitment tx is the latest valid state, use their latest
3093                         // per-commitment point
3094                         if per_commitment_points.0 == commitment_number { &per_commitment_points.1 }
3095                         else if let Some(point) = per_commitment_points.2.as_ref() {
3096                                 // If counterparty commitment tx is the state previous to the latest valid state, use
3097                                 // their previous per-commitment point (non-atomicity of revocation means it's valid for
3098                                 // them to temporarily have two valid commitment txns from our viewpoint)
3099                                 if per_commitment_points.0 == commitment_number + 1 {
3100                                         point
3101                                 } else { return (claimable_outpoints, to_counterparty_output_info); }
3102                         } else { return (claimable_outpoints, to_counterparty_output_info); };
3103
3104                 if let Some(transaction) = tx {
3105                         let revocation_pubkey = chan_utils::derive_public_revocation_key(
3106                                 &self.onchain_tx_handler.secp_ctx, &per_commitment_point, &self.holder_revocation_basepoint);
3107                         let delayed_key = chan_utils::derive_public_key(&self.onchain_tx_handler.secp_ctx,
3108                                 &per_commitment_point,
3109                                 &self.counterparty_commitment_params.counterparty_delayed_payment_base_key);
3110                         let revokeable_p2wsh = chan_utils::get_revokeable_redeemscript(&revocation_pubkey,
3111                                 self.counterparty_commitment_params.on_counterparty_tx_csv,
3112                                 &delayed_key).to_v0_p2wsh();
3113                         for (idx, outp) in transaction.output.iter().enumerate() {
3114                                 if outp.script_pubkey == revokeable_p2wsh {
3115                                         to_counterparty_output_info =
3116                                                 Some((idx.try_into().expect("Can't have > 2^32 outputs"), outp.value));
3117                                 }
3118                         }
3119                 }
3120
3121                 for (_, &(ref htlc, _)) in htlc_outputs.iter().enumerate() {
3122                         if let Some(transaction_output_index) = htlc.transaction_output_index {
3123                                 if let Some(transaction) = tx {
3124                                         if transaction_output_index as usize >= transaction.output.len() ||
3125                                                 transaction.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 {
3126                                                         // per_commitment_data is corrupt or our commitment signing key leaked!
3127                                                         return (claimable_outpoints, to_counterparty_output_info);
3128                                                 }
3129                                 }
3130                                 let preimage = if htlc.offered { if let Some(p) = self.payment_preimages.get(&htlc.payment_hash) { Some(*p) } else { None } } else { None };
3131                                 if preimage.is_some() || !htlc.offered {
3132                                         let counterparty_htlc_outp = if htlc.offered {
3133                                                 PackageSolvingData::CounterpartyOfferedHTLCOutput(
3134                                                         CounterpartyOfferedHTLCOutput::build(*per_commitment_point,
3135                                                                 self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
3136                                                                 self.counterparty_commitment_params.counterparty_htlc_base_key,
3137                                                                 preimage.unwrap(), htlc.clone(), self.onchain_tx_handler.channel_type_features().clone()))
3138                                         } else {
3139                                                 PackageSolvingData::CounterpartyReceivedHTLCOutput(
3140                                                         CounterpartyReceivedHTLCOutput::build(*per_commitment_point,
3141                                                                 self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
3142                                                                 self.counterparty_commitment_params.counterparty_htlc_base_key,
3143                                                                 htlc.clone(), self.onchain_tx_handler.channel_type_features().clone()))
3144                                         };
3145                                         let counterparty_package = PackageTemplate::build_package(commitment_txid, transaction_output_index, counterparty_htlc_outp, htlc.cltv_expiry, 0);
3146                                         claimable_outpoints.push(counterparty_package);
3147                                 }
3148                         }
3149                 }
3150
3151                 (claimable_outpoints, to_counterparty_output_info)
3152         }
3153
3154         /// Attempts to claim a counterparty HTLC-Success/HTLC-Timeout's outputs using the revocation key
3155         fn check_spend_counterparty_htlc<L: Deref>(
3156                 &mut self, tx: &Transaction, commitment_number: u64, commitment_txid: &Txid, height: u32, logger: &L
3157         ) -> (Vec<PackageTemplate>, Option<TransactionOutputs>) where L::Target: Logger {
3158                 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (Vec::new(), None); };
3159                 let per_commitment_key = match SecretKey::from_slice(&secret) {
3160                         Ok(key) => key,
3161                         Err(_) => return (Vec::new(), None)
3162                 };
3163                 let per_commitment_point = PublicKey::from_secret_key(&self.onchain_tx_handler.secp_ctx, &per_commitment_key);
3164
3165                 let htlc_txid = tx.txid();
3166                 let mut claimable_outpoints = vec![];
3167                 let mut outputs_to_watch = None;
3168                 // Previously, we would only claim HTLCs from revoked HTLC transactions if they had 1 input
3169                 // with a witness of 5 elements and 1 output. This wasn't enough for anchor outputs, as the
3170                 // counterparty can now aggregate multiple HTLCs into a single transaction thanks to
3171                 // `SIGHASH_SINGLE` remote signatures, leading us to not claim any HTLCs upon seeing a
3172                 // confirmed revoked HTLC transaction (for more details, see
3173                 // https://lists.linuxfoundation.org/pipermail/lightning-dev/2022-April/003561.html).
3174                 //
3175                 // We make sure we're not vulnerable to this case by checking all inputs of the transaction,
3176                 // and claim those which spend the commitment transaction, have a witness of 5 elements, and
3177                 // have a corresponding output at the same index within the transaction.
3178                 for (idx, input) in tx.input.iter().enumerate() {
3179                         if input.previous_output.txid == *commitment_txid && input.witness.len() == 5 && tx.output.get(idx).is_some() {
3180                                 log_error!(logger, "Got broadcast of revoked counterparty HTLC transaction, spending {}:{}", htlc_txid, idx);
3181                                 let revk_outp = RevokedOutput::build(
3182                                         per_commitment_point, self.counterparty_commitment_params.counterparty_delayed_payment_base_key,
3183                                         self.counterparty_commitment_params.counterparty_htlc_base_key, per_commitment_key,
3184                                         tx.output[idx].value, self.counterparty_commitment_params.on_counterparty_tx_csv,
3185                                         false
3186                                 );
3187                                 let justice_package = PackageTemplate::build_package(
3188                                         htlc_txid, idx as u32, PackageSolvingData::RevokedOutput(revk_outp),
3189                                         height + self.counterparty_commitment_params.on_counterparty_tx_csv as u32, height
3190                                 );
3191                                 claimable_outpoints.push(justice_package);
3192                                 if outputs_to_watch.is_none() {
3193                                         outputs_to_watch = Some((htlc_txid, vec![]));
3194                                 }
3195                                 outputs_to_watch.as_mut().unwrap().1.push((idx as u32, tx.output[idx].clone()));
3196                         }
3197                 }
3198                 (claimable_outpoints, outputs_to_watch)
3199         }
3200
3201         // Returns (1) `PackageTemplate`s that can be given to the OnchainTxHandler, so that the handler can
3202         // broadcast transactions claiming holder HTLC commitment outputs and (2) a holder revokable
3203         // script so we can detect whether a holder transaction has been seen on-chain.
3204         fn get_broadcasted_holder_claims(&self, holder_tx: &HolderSignedTx, conf_height: u32) -> (Vec<PackageTemplate>, Option<(Script, PublicKey, PublicKey)>) {
3205                 let mut claim_requests = Vec::with_capacity(holder_tx.htlc_outputs.len());
3206
3207                 let redeemscript = chan_utils::get_revokeable_redeemscript(&holder_tx.revocation_key, self.on_holder_tx_csv, &holder_tx.delayed_payment_key);
3208                 let broadcasted_holder_revokable_script = Some((redeemscript.to_v0_p2wsh(), holder_tx.per_commitment_point.clone(), holder_tx.revocation_key.clone()));
3209
3210                 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
3211                         if let Some(transaction_output_index) = htlc.transaction_output_index {
3212                                 let htlc_output = if htlc.offered {
3213                                         let htlc_output = HolderHTLCOutput::build_offered(
3214                                                 htlc.amount_msat, htlc.cltv_expiry, self.onchain_tx_handler.channel_type_features().clone()
3215                                         );
3216                                         htlc_output
3217                                 } else {
3218                                         let payment_preimage = if let Some(preimage) = self.payment_preimages.get(&htlc.payment_hash) {
3219                                                 preimage.clone()
3220                                         } else {
3221                                                 // We can't build an HTLC-Success transaction without the preimage
3222                                                 continue;
3223                                         };
3224                                         let htlc_output = HolderHTLCOutput::build_accepted(
3225                                                 payment_preimage, htlc.amount_msat, self.onchain_tx_handler.channel_type_features().clone()
3226                                         );
3227                                         htlc_output
3228                                 };
3229                                 let htlc_package = PackageTemplate::build_package(
3230                                         holder_tx.txid, transaction_output_index,
3231                                         PackageSolvingData::HolderHTLCOutput(htlc_output),
3232                                         htlc.cltv_expiry, conf_height
3233                                 );
3234                                 claim_requests.push(htlc_package);
3235                         }
3236                 }
3237
3238                 (claim_requests, broadcasted_holder_revokable_script)
3239         }
3240
3241         // Returns holder HTLC outputs to watch and react to in case of spending.
3242         fn get_broadcasted_holder_watch_outputs(&self, holder_tx: &HolderSignedTx, commitment_tx: &Transaction) -> Vec<(u32, TxOut)> {
3243                 let mut watch_outputs = Vec::with_capacity(holder_tx.htlc_outputs.len());
3244                 for &(ref htlc, _, _) in holder_tx.htlc_outputs.iter() {
3245                         if let Some(transaction_output_index) = htlc.transaction_output_index {
3246                                 watch_outputs.push((transaction_output_index, commitment_tx.output[transaction_output_index as usize].clone()));
3247                         }
3248                 }
3249                 watch_outputs
3250         }
3251
3252         /// Attempts to claim any claimable HTLCs in a commitment transaction which was not (yet)
3253         /// revoked using data in holder_claimable_outpoints.
3254         /// Should not be used if check_spend_revoked_transaction succeeds.
3255         /// Returns None unless the transaction is definitely one of our commitment transactions.
3256         fn check_spend_holder_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L) -> Option<(Vec<PackageTemplate>, TransactionOutputs)> where L::Target: Logger {
3257                 let commitment_txid = tx.txid();
3258                 let mut claim_requests = Vec::new();
3259                 let mut watch_outputs = Vec::new();
3260
3261                 macro_rules! append_onchain_update {
3262                         ($updates: expr, $to_watch: expr) => {
3263                                 claim_requests = $updates.0;
3264                                 self.broadcasted_holder_revokable_script = $updates.1;
3265                                 watch_outputs.append(&mut $to_watch);
3266                         }
3267                 }
3268
3269                 // HTLCs set may differ between last and previous holder commitment txn, in case of one them hitting chain, ensure we cancel all HTLCs backward
3270                 let mut is_holder_tx = false;
3271
3272                 if self.current_holder_commitment_tx.txid == commitment_txid {
3273                         is_holder_tx = true;
3274                         log_info!(logger, "Got broadcast of latest holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
3275                         let res = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, height);
3276                         let mut to_watch = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, tx);
3277                         append_onchain_update!(res, to_watch);
3278                         fail_unbroadcast_htlcs!(self, "latest holder", commitment_txid, tx, height,
3279                                 block_hash, self.current_holder_commitment_tx.htlc_outputs.iter()
3280                                 .map(|(htlc, _, htlc_source)| (htlc, htlc_source.as_ref())), logger);
3281                 } else if let &Some(ref holder_tx) = &self.prev_holder_signed_commitment_tx {
3282                         if holder_tx.txid == commitment_txid {
3283                                 is_holder_tx = true;
3284                                 log_info!(logger, "Got broadcast of previous holder commitment tx {}, searching for available HTLCs to claim", commitment_txid);
3285                                 let res = self.get_broadcasted_holder_claims(holder_tx, height);
3286                                 let mut to_watch = self.get_broadcasted_holder_watch_outputs(holder_tx, tx);
3287                                 append_onchain_update!(res, to_watch);
3288                                 fail_unbroadcast_htlcs!(self, "previous holder", commitment_txid, tx, height, block_hash,
3289                                         holder_tx.htlc_outputs.iter().map(|(htlc, _, htlc_source)| (htlc, htlc_source.as_ref())),
3290                                         logger);
3291                         }
3292                 }
3293
3294                 if is_holder_tx {
3295                         Some((claim_requests, (commitment_txid, watch_outputs)))
3296                 } else {
3297                         None
3298                 }
3299         }
3300
3301         pub fn get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
3302                 log_debug!(logger, "Getting signed latest holder commitment transaction!");
3303                 self.holder_tx_signed = true;
3304                 let commitment_tx = self.onchain_tx_handler.get_fully_signed_holder_tx(&self.funding_redeemscript);
3305                 let txid = commitment_tx.txid();
3306                 let mut holder_transactions = vec![commitment_tx];
3307                 // When anchor outputs are present, the HTLC transactions are only valid once the commitment
3308                 // transaction confirms.
3309                 if self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
3310                         return holder_transactions;
3311                 }
3312                 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
3313                         if let Some(vout) = htlc.0.transaction_output_index {
3314                                 let preimage = if !htlc.0.offered {
3315                                         if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
3316                                                 // We can't build an HTLC-Success transaction without the preimage
3317                                                 continue;
3318                                         }
3319                                 } else if htlc.0.cltv_expiry > self.best_block.height() + 1 {
3320                                         // Don't broadcast HTLC-Timeout transactions immediately as they don't meet the
3321                                         // current locktime requirements on-chain. We will broadcast them in
3322                                         // `block_confirmed` when `should_broadcast_holder_commitment_txn` returns true.
3323                                         // Note that we add + 1 as transactions are broadcastable when they can be
3324                                         // confirmed in the next block.
3325                                         continue;
3326                                 } else { None };
3327                                 if let Some(htlc_tx) = self.onchain_tx_handler.get_fully_signed_htlc_tx(
3328                                         &::bitcoin::OutPoint { txid, vout }, &preimage) {
3329                                         holder_transactions.push(htlc_tx);
3330                                 }
3331                         }
3332                 }
3333                 // 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.
3334                 // The data will be re-generated and tracked in check_spend_holder_transaction if we get a confirmation.
3335                 holder_transactions
3336         }
3337
3338         #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
3339         /// Note that this includes possibly-locktimed-in-the-future transactions!
3340         fn unsafe_get_latest_holder_commitment_txn<L: Deref>(&mut self, logger: &L) -> Vec<Transaction> where L::Target: Logger {
3341                 log_debug!(logger, "Getting signed copy of latest holder commitment transaction!");
3342                 let commitment_tx = self.onchain_tx_handler.get_fully_signed_copy_holder_tx(&self.funding_redeemscript);
3343                 let txid = commitment_tx.txid();
3344                 let mut holder_transactions = vec![commitment_tx];
3345                 // When anchor outputs are present, the HTLC transactions are only final once the commitment
3346                 // transaction confirms due to the CSV 1 encumberance.
3347                 if self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
3348                         return holder_transactions;
3349                 }
3350                 for htlc in self.current_holder_commitment_tx.htlc_outputs.iter() {
3351                         if let Some(vout) = htlc.0.transaction_output_index {
3352                                 let preimage = if !htlc.0.offered {
3353                                         if let Some(preimage) = self.payment_preimages.get(&htlc.0.payment_hash) { Some(preimage.clone()) } else {
3354                                                 // We can't build an HTLC-Success transaction without the preimage
3355                                                 continue;
3356                                         }
3357                                 } else { None };
3358                                 if let Some(htlc_tx) = self.onchain_tx_handler.unsafe_get_fully_signed_htlc_tx(
3359                                         &::bitcoin::OutPoint { txid, vout }, &preimage) {
3360                                         holder_transactions.push(htlc_tx);
3361                                 }
3362                         }
3363                 }
3364                 holder_transactions
3365         }
3366
3367         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>
3368                 where B::Target: BroadcasterInterface,
3369                       F::Target: FeeEstimator,
3370                                         L::Target: Logger,
3371         {
3372                 let block_hash = header.block_hash();
3373                 self.best_block = BestBlock::new(block_hash, height);
3374
3375                 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
3376                 self.transactions_confirmed(header, txdata, height, broadcaster, &bounded_fee_estimator, logger)
3377         }
3378
3379         fn best_block_updated<B: Deref, F: Deref, L: Deref>(
3380                 &mut self,
3381                 header: &BlockHeader,
3382                 height: u32,
3383                 broadcaster: B,
3384                 fee_estimator: &LowerBoundedFeeEstimator<F>,
3385                 logger: L,
3386         ) -> Vec<TransactionOutputs>
3387         where
3388                 B::Target: BroadcasterInterface,
3389                 F::Target: FeeEstimator,
3390                 L::Target: Logger,
3391         {
3392                 let block_hash = header.block_hash();
3393
3394                 if height > self.best_block.height() {
3395                         self.best_block = BestBlock::new(block_hash, height);
3396                         self.block_confirmed(height, block_hash, vec![], vec![], vec![], &broadcaster, &fee_estimator, &logger)
3397                 } else if block_hash != self.best_block.block_hash() {
3398                         self.best_block = BestBlock::new(block_hash, height);
3399                         self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height <= height);
3400                         self.onchain_tx_handler.block_disconnected(height + 1, broadcaster, fee_estimator, logger);
3401                         Vec::new()
3402                 } else { Vec::new() }
3403         }
3404
3405         fn transactions_confirmed<B: Deref, F: Deref, L: Deref>(
3406                 &mut self,
3407                 header: &BlockHeader,
3408                 txdata: &TransactionData,
3409                 height: u32,
3410                 broadcaster: B,
3411                 fee_estimator: &LowerBoundedFeeEstimator<F>,
3412                 logger: L,
3413         ) -> Vec<TransactionOutputs>
3414         where
3415                 B::Target: BroadcasterInterface,
3416                 F::Target: FeeEstimator,
3417                 L::Target: Logger,
3418         {
3419                 let txn_matched = self.filter_block(txdata);
3420                 for tx in &txn_matched {
3421                         let mut output_val = 0;
3422                         for out in tx.output.iter() {
3423                                 if out.value > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
3424                                 output_val += out.value;
3425                                 if output_val > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
3426                         }
3427                 }
3428
3429                 let block_hash = header.block_hash();
3430
3431                 let mut watch_outputs = Vec::new();
3432                 let mut claimable_outpoints = Vec::new();
3433                 'tx_iter: for tx in &txn_matched {
3434                         let txid = tx.txid();
3435                         // If a transaction has already been confirmed, ensure we don't bother processing it duplicatively.
3436                         if Some(txid) == self.funding_spend_confirmed {
3437                                 log_debug!(logger, "Skipping redundant processing of funding-spend tx {} as it was previously confirmed", txid);
3438                                 continue 'tx_iter;
3439                         }
3440                         for ev in self.onchain_events_awaiting_threshold_conf.iter() {
3441                                 if ev.txid == txid {
3442                                         if let Some(conf_hash) = ev.block_hash {
3443                                                 assert_eq!(header.block_hash(), conf_hash,
3444                                                         "Transaction {} was already confirmed and is being re-confirmed in a different block.\n\
3445                                                         This indicates a severe bug in the transaction connection logic - a reorg should have been processed first!", ev.txid);
3446                                         }
3447                                         log_debug!(logger, "Skipping redundant processing of confirming tx {} as it was previously confirmed", txid);
3448                                         continue 'tx_iter;
3449                                 }
3450                         }
3451                         for htlc in self.htlcs_resolved_on_chain.iter() {
3452                                 if Some(txid) == htlc.resolving_txid {
3453                                         log_debug!(logger, "Skipping redundant processing of HTLC resolution tx {} as it was previously confirmed", txid);
3454                                         continue 'tx_iter;
3455                                 }
3456                         }
3457                         for spendable_txid in self.spendable_txids_confirmed.iter() {
3458                                 if txid == *spendable_txid {
3459                                         log_debug!(logger, "Skipping redundant processing of spendable tx {} as it was previously confirmed", txid);
3460                                         continue 'tx_iter;
3461                                 }
3462                         }
3463
3464                         if tx.input.len() == 1 {
3465                                 // Assuming our keys were not leaked (in which case we're screwed no matter what),
3466                                 // commitment transactions and HTLC transactions will all only ever have one input
3467                                 // (except for HTLC transactions for channels with anchor outputs), which is an easy
3468                                 // way to filter out any potential non-matching txn for lazy filters.
3469                                 let prevout = &tx.input[0].previous_output;
3470                                 if prevout.txid == self.funding_info.0.txid && prevout.vout == self.funding_info.0.index as u32 {
3471                                         let mut balance_spendable_csv = None;
3472                                         log_info!(logger, "Channel {} closed by funding output spend in txid {}.",
3473                                                 &self.funding_info.0.to_channel_id(), txid);
3474                                         self.funding_spend_seen = true;
3475                                         let mut commitment_tx_to_counterparty_output = None;
3476                                         if (tx.input[0].sequence.0 >> 8*3) as u8 == 0x80 && (tx.lock_time.0 >> 8*3) as u8 == 0x20 {
3477                                                 let (mut new_outpoints, new_outputs, counterparty_output_idx_sats) =
3478                                                         self.check_spend_counterparty_transaction(&tx, height, &block_hash, &logger);
3479                                                 commitment_tx_to_counterparty_output = counterparty_output_idx_sats;
3480                                                 if !new_outputs.1.is_empty() {
3481                                                         watch_outputs.push(new_outputs);
3482                                                 }
3483                                                 claimable_outpoints.append(&mut new_outpoints);
3484                                                 if new_outpoints.is_empty() {
3485                                                         if let Some((mut new_outpoints, new_outputs)) = self.check_spend_holder_transaction(&tx, height, &block_hash, &logger) {
3486                                                                 debug_assert!(commitment_tx_to_counterparty_output.is_none(),
3487                                                                         "A commitment transaction matched as both a counterparty and local commitment tx?");
3488                                                                 if !new_outputs.1.is_empty() {
3489                                                                         watch_outputs.push(new_outputs);
3490                                                                 }
3491                                                                 claimable_outpoints.append(&mut new_outpoints);
3492                                                                 balance_spendable_csv = Some(self.on_holder_tx_csv);
3493                                                         }
3494                                                 }
3495                                         }
3496                                         self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3497                                                 txid,
3498                                                 transaction: Some((*tx).clone()),
3499                                                 height,
3500                                                 block_hash: Some(block_hash),
3501                                                 event: OnchainEvent::FundingSpendConfirmation {
3502                                                         on_local_output_csv: balance_spendable_csv,
3503                                                         commitment_tx_to_counterparty_output,
3504                                                 },
3505                                         });
3506                                 }
3507                         }
3508                         if tx.input.len() >= 1 {
3509                                 // While all commitment transactions have one input, HTLC transactions may have more
3510                                 // if the HTLC was present in an anchor channel. HTLCs can also be resolved in a few
3511                                 // other ways which can have more than one output.
3512                                 for tx_input in &tx.input {
3513                                         let commitment_txid = tx_input.previous_output.txid;
3514                                         if let Some(&commitment_number) = self.counterparty_commitment_txn_on_chain.get(&commitment_txid) {
3515                                                 let (mut new_outpoints, new_outputs_option) = self.check_spend_counterparty_htlc(
3516                                                         &tx, commitment_number, &commitment_txid, height, &logger
3517                                                 );
3518                                                 claimable_outpoints.append(&mut new_outpoints);
3519                                                 if let Some(new_outputs) = new_outputs_option {
3520                                                         watch_outputs.push(new_outputs);
3521                                                 }
3522                                                 // Since there may be multiple HTLCs for this channel (all spending the
3523                                                 // same commitment tx) being claimed by the counterparty within the same
3524                                                 // transaction, and `check_spend_counterparty_htlc` already checks all the
3525                                                 // ones relevant to this channel, we can safely break from our loop.
3526                                                 break;
3527                                         }
3528                                 }
3529                                 self.is_resolving_htlc_output(&tx, height, &block_hash, &logger);
3530
3531                                 self.check_tx_and_push_spendable_outputs(&tx, height, &block_hash, &logger);
3532                         }
3533                 }
3534
3535                 if height > self.best_block.height() {
3536                         self.best_block = BestBlock::new(block_hash, height);
3537                 }
3538
3539                 self.block_confirmed(height, block_hash, txn_matched, watch_outputs, claimable_outpoints, &broadcaster, &fee_estimator, &logger)
3540         }
3541
3542         /// Update state for new block(s)/transaction(s) confirmed. Note that the caller must update
3543         /// `self.best_block` before calling if a new best blockchain tip is available. More
3544         /// concretely, `self.best_block` must never be at a lower height than `conf_height`, avoiding
3545         /// complexity especially in
3546         /// `OnchainTx::update_claims_view_from_requests`/`OnchainTx::update_claims_view_from_matched_txn`.
3547         ///
3548         /// `conf_height` should be set to the height at which any new transaction(s)/block(s) were
3549         /// confirmed at, even if it is not the current best height.
3550         fn block_confirmed<B: Deref, F: Deref, L: Deref>(
3551                 &mut self,
3552                 conf_height: u32,
3553                 conf_hash: BlockHash,
3554                 txn_matched: Vec<&Transaction>,
3555                 mut watch_outputs: Vec<TransactionOutputs>,
3556                 mut claimable_outpoints: Vec<PackageTemplate>,
3557                 broadcaster: &B,
3558                 fee_estimator: &LowerBoundedFeeEstimator<F>,
3559                 logger: &L,
3560         ) -> Vec<TransactionOutputs>
3561         where
3562                 B::Target: BroadcasterInterface,
3563                 F::Target: FeeEstimator,
3564                 L::Target: Logger,
3565         {
3566                 log_trace!(logger, "Processing {} matched transactions for block at height {}.", txn_matched.len(), conf_height);
3567                 debug_assert!(self.best_block.height() >= conf_height);
3568
3569                 let should_broadcast = self.should_broadcast_holder_commitment_txn(logger);
3570                 if should_broadcast {
3571                         let funding_outp = HolderFundingOutput::build(self.funding_redeemscript.clone(), self.channel_value_satoshis, self.onchain_tx_handler.channel_type_features().clone());
3572                         let commitment_package = PackageTemplate::build_package(self.funding_info.0.txid.clone(), self.funding_info.0.index as u32, PackageSolvingData::HolderFundingOutput(funding_outp), self.best_block.height(), self.best_block.height());
3573                         claimable_outpoints.push(commitment_package);
3574                         self.pending_monitor_events.push(MonitorEvent::HolderForceClosed(self.funding_info.0));
3575                         // Although we aren't signing the transaction directly here, the transaction will be signed
3576                         // in the claim that is queued to OnchainTxHandler. We set holder_tx_signed here to reject
3577                         // new channel updates.
3578                         self.holder_tx_signed = true;
3579                         // We can't broadcast our HTLC transactions while the commitment transaction is
3580                         // unconfirmed. We'll delay doing so until we detect the confirmed commitment in
3581                         // `transactions_confirmed`.
3582                         if !self.onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() {
3583                                 // Because we're broadcasting a commitment transaction, we should construct the package
3584                                 // assuming it gets confirmed in the next block. Sadly, we have code which considers
3585                                 // "not yet confirmed" things as discardable, so we cannot do that here.
3586                                 let (mut new_outpoints, _) = self.get_broadcasted_holder_claims(&self.current_holder_commitment_tx, self.best_block.height());
3587                                 let unsigned_commitment_tx = self.onchain_tx_handler.get_unsigned_holder_commitment_tx();
3588                                 let new_outputs = self.get_broadcasted_holder_watch_outputs(&self.current_holder_commitment_tx, &unsigned_commitment_tx);
3589                                 if !new_outputs.is_empty() {
3590                                         watch_outputs.push((self.current_holder_commitment_tx.txid.clone(), new_outputs));
3591                                 }
3592                                 claimable_outpoints.append(&mut new_outpoints);
3593                         }
3594                 }
3595
3596                 // Find which on-chain events have reached their confirmation threshold.
3597                 let onchain_events_awaiting_threshold_conf =
3598                         self.onchain_events_awaiting_threshold_conf.drain(..).collect::<Vec<_>>();
3599                 let mut onchain_events_reaching_threshold_conf = Vec::new();
3600                 for entry in onchain_events_awaiting_threshold_conf {
3601                         if entry.has_reached_confirmation_threshold(&self.best_block) {
3602                                 onchain_events_reaching_threshold_conf.push(entry);
3603                         } else {
3604                                 self.onchain_events_awaiting_threshold_conf.push(entry);
3605                         }
3606                 }
3607
3608                 // Used to check for duplicate HTLC resolutions.
3609                 #[cfg(debug_assertions)]
3610                 let unmatured_htlcs: Vec<_> = self.onchain_events_awaiting_threshold_conf
3611                         .iter()
3612                         .filter_map(|entry| match &entry.event {
3613                                 OnchainEvent::HTLCUpdate { source, .. } => Some(source),
3614                                 _ => None,
3615                         })
3616                         .collect();
3617                 #[cfg(debug_assertions)]
3618                 let mut matured_htlcs = Vec::new();
3619
3620                 // Produce actionable events from on-chain events having reached their threshold.
3621                 for entry in onchain_events_reaching_threshold_conf.drain(..) {
3622                         match entry.event {
3623                                 OnchainEvent::HTLCUpdate { ref source, payment_hash, htlc_value_satoshis, commitment_tx_output_idx } => {
3624                                         // Check for duplicate HTLC resolutions.
3625                                         #[cfg(debug_assertions)]
3626                                         {
3627                                                 debug_assert!(
3628                                                         unmatured_htlcs.iter().find(|&htlc| htlc == &source).is_none(),
3629                                                         "An unmature HTLC transaction conflicts with a maturing one; failed to \
3630                                                          call either transaction_unconfirmed for the conflicting transaction \
3631                                                          or block_disconnected for a block containing it.");
3632                                                 debug_assert!(
3633                                                         matured_htlcs.iter().find(|&htlc| htlc == source).is_none(),
3634                                                         "A matured HTLC transaction conflicts with a maturing one; failed to \
3635                                                          call either transaction_unconfirmed for the conflicting transaction \
3636                                                          or block_disconnected for a block containing it.");
3637                                                 matured_htlcs.push(source.clone());
3638                                         }
3639
3640                                         log_debug!(logger, "HTLC {} failure update in {} has got enough confirmations to be passed upstream",
3641                                                 &payment_hash, entry.txid);
3642                                         self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
3643                                                 payment_hash,
3644                                                 payment_preimage: None,
3645                                                 source: source.clone(),
3646                                                 htlc_value_satoshis,
3647                                         }));
3648                                         self.htlcs_resolved_on_chain.push(IrrevocablyResolvedHTLC {
3649                                                 commitment_tx_output_idx,
3650                                                 resolving_txid: Some(entry.txid),
3651                                                 resolving_tx: entry.transaction,
3652                                                 payment_preimage: None,
3653                                         });
3654                                 },
3655                                 OnchainEvent::MaturingOutput { descriptor } => {
3656                                         log_debug!(logger, "Descriptor {} has got enough confirmations to be passed upstream", log_spendable!(descriptor));
3657                                         self.pending_events.push(Event::SpendableOutputs {
3658                                                 outputs: vec![descriptor],
3659                                                 channel_id: Some(self.funding_info.0.to_channel_id()),
3660                                         });
3661                                         self.spendable_txids_confirmed.push(entry.txid);
3662                                 },
3663                                 OnchainEvent::HTLCSpendConfirmation { commitment_tx_output_idx, preimage, .. } => {
3664                                         self.htlcs_resolved_on_chain.push(IrrevocablyResolvedHTLC {
3665                                                 commitment_tx_output_idx: Some(commitment_tx_output_idx),
3666                                                 resolving_txid: Some(entry.txid),
3667                                                 resolving_tx: entry.transaction,
3668                                                 payment_preimage: preimage,
3669                                         });
3670                                 },
3671                                 OnchainEvent::FundingSpendConfirmation { commitment_tx_to_counterparty_output, .. } => {
3672                                         self.funding_spend_confirmed = Some(entry.txid);
3673                                         self.confirmed_commitment_tx_counterparty_output = commitment_tx_to_counterparty_output;
3674                                 },
3675                         }
3676                 }
3677
3678                 self.onchain_tx_handler.update_claims_view_from_requests(claimable_outpoints, conf_height, self.best_block.height(), broadcaster, fee_estimator, logger);
3679                 self.onchain_tx_handler.update_claims_view_from_matched_txn(&txn_matched, conf_height, conf_hash, self.best_block.height(), broadcaster, fee_estimator, logger);
3680
3681                 // Determine new outputs to watch by comparing against previously known outputs to watch,
3682                 // updating the latter in the process.
3683                 watch_outputs.retain(|&(ref txid, ref txouts)| {
3684                         let idx_and_scripts = txouts.iter().map(|o| (o.0, o.1.script_pubkey.clone())).collect();
3685                         self.outputs_to_watch.insert(txid.clone(), idx_and_scripts).is_none()
3686                 });
3687                 #[cfg(test)]
3688                 {
3689                         // If we see a transaction for which we registered outputs previously,
3690                         // make sure the registered scriptpubkey at the expected index match
3691                         // the actual transaction output one. We failed this case before #653.
3692                         for tx in &txn_matched {
3693                                 if let Some(outputs) = self.get_outputs_to_watch().get(&tx.txid()) {
3694                                         for idx_and_script in outputs.iter() {
3695                                                 assert!((idx_and_script.0 as usize) < tx.output.len());
3696                                                 assert_eq!(tx.output[idx_and_script.0 as usize].script_pubkey, idx_and_script.1);
3697                                         }
3698                                 }
3699                         }
3700                 }
3701                 watch_outputs
3702         }
3703
3704         pub fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, header: &BlockHeader, height: u32, broadcaster: B, fee_estimator: F, logger: L)
3705                 where B::Target: BroadcasterInterface,
3706                       F::Target: FeeEstimator,
3707                       L::Target: Logger,
3708         {
3709                 log_trace!(logger, "Block {} at height {} disconnected", header.block_hash(), height);
3710
3711                 //We may discard:
3712                 //- htlc update there as failure-trigger tx (revoked commitment tx, non-revoked commitment tx, HTLC-timeout tx) has been disconnected
3713                 //- maturing spendable output has transaction paying us has been disconnected
3714                 self.onchain_events_awaiting_threshold_conf.retain(|ref entry| entry.height < height);
3715
3716                 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(fee_estimator);
3717                 self.onchain_tx_handler.block_disconnected(height, broadcaster, &bounded_fee_estimator, logger);
3718
3719                 self.best_block = BestBlock::new(header.prev_blockhash, height - 1);
3720         }
3721
3722         fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
3723                 &mut self,
3724                 txid: &Txid,
3725                 broadcaster: B,
3726                 fee_estimator: &LowerBoundedFeeEstimator<F>,
3727                 logger: L,
3728         ) where
3729                 B::Target: BroadcasterInterface,
3730                 F::Target: FeeEstimator,
3731                 L::Target: Logger,
3732         {
3733                 let mut removed_height = None;
3734                 for entry in self.onchain_events_awaiting_threshold_conf.iter() {
3735                         if entry.txid == *txid {
3736                                 removed_height = Some(entry.height);
3737                                 break;
3738                         }
3739                 }
3740
3741                 if let Some(removed_height) = removed_height {
3742                         log_info!(logger, "transaction_unconfirmed of txid {} implies height {} was reorg'd out", txid, removed_height);
3743                         self.onchain_events_awaiting_threshold_conf.retain(|ref entry| if entry.height >= removed_height {
3744                                 log_info!(logger, "Transaction {} reorg'd out", entry.txid);
3745                                 false
3746                         } else { true });
3747                 }
3748
3749                 debug_assert!(!self.onchain_events_awaiting_threshold_conf.iter().any(|ref entry| entry.txid == *txid));
3750
3751                 self.onchain_tx_handler.transaction_unconfirmed(txid, broadcaster, fee_estimator, logger);
3752         }
3753
3754         /// Filters a block's `txdata` for transactions spending watched outputs or for any child
3755         /// transactions thereof.
3756         fn filter_block<'a>(&self, txdata: &TransactionData<'a>) -> Vec<&'a Transaction> {
3757                 let mut matched_txn = HashSet::new();
3758                 txdata.iter().filter(|&&(_, tx)| {
3759                         let mut matches = self.spends_watched_output(tx);
3760                         for input in tx.input.iter() {
3761                                 if matches { break; }
3762                                 if matched_txn.contains(&input.previous_output.txid) {
3763                                         matches = true;
3764                                 }
3765                         }
3766                         if matches {
3767                                 matched_txn.insert(tx.txid());
3768                         }
3769                         matches
3770                 }).map(|(_, tx)| *tx).collect()
3771         }
3772
3773         /// Checks if a given transaction spends any watched outputs.
3774         fn spends_watched_output(&self, tx: &Transaction) -> bool {
3775                 for input in tx.input.iter() {
3776                         if let Some(outputs) = self.get_outputs_to_watch().get(&input.previous_output.txid) {
3777                                 for (idx, _script_pubkey) in outputs.iter() {
3778                                         if *idx == input.previous_output.vout {
3779                                                 #[cfg(test)]
3780                                                 {
3781                                                         // If the expected script is a known type, check that the witness
3782                                                         // appears to be spending the correct type (ie that the match would
3783                                                         // actually succeed in BIP 158/159-style filters).
3784                                                         if _script_pubkey.is_v0_p2wsh() {
3785                                                                 if input.witness.last().unwrap().to_vec() == deliberately_bogus_accepted_htlc_witness_program() {
3786                                                                         // In at least one test we use a deliberately bogus witness
3787                                                                         // script which hit an old panic. Thus, we check for that here
3788                                                                         // and avoid the assert if its the expected bogus script.
3789                                                                         return true;
3790                                                                 }
3791
3792                                                                 assert_eq!(&bitcoin::Address::p2wsh(&Script::from(input.witness.last().unwrap().to_vec()), bitcoin::Network::Bitcoin).script_pubkey(), _script_pubkey);
3793                                                         } else if _script_pubkey.is_v0_p2wpkh() {
3794                                                                 assert_eq!(&bitcoin::Address::p2wpkh(&bitcoin::PublicKey::from_slice(&input.witness.last().unwrap()).unwrap(), bitcoin::Network::Bitcoin).unwrap().script_pubkey(), _script_pubkey);
3795                                                         } else { panic!(); }
3796                                                 }
3797                                                 return true;
3798                                         }
3799                                 }
3800                         }
3801                 }
3802
3803                 false
3804         }
3805
3806         fn should_broadcast_holder_commitment_txn<L: Deref>(&self, logger: &L) -> bool where L::Target: Logger {
3807                 // There's no need to broadcast our commitment transaction if we've seen one confirmed (even
3808                 // with 1 confirmation) as it'll be rejected as duplicate/conflicting.
3809                 if self.funding_spend_confirmed.is_some() ||
3810                         self.onchain_events_awaiting_threshold_conf.iter().find(|event| match event.event {
3811                                 OnchainEvent::FundingSpendConfirmation { .. } => true,
3812                                 _ => false,
3813                         }).is_some()
3814                 {
3815                         return false;
3816                 }
3817                 // We need to consider all HTLCs which are:
3818                 //  * in any unrevoked counterparty commitment transaction, as they could broadcast said
3819                 //    transactions and we'd end up in a race, or
3820                 //  * are in our latest holder commitment transaction, as this is the thing we will
3821                 //    broadcast if we go on-chain.
3822                 // Note that we consider HTLCs which were below dust threshold here - while they don't
3823                 // strictly imply that we need to fail the channel, we need to go ahead and fail them back
3824                 // to the source, and if we don't fail the channel we will have to ensure that the next
3825                 // updates that peer sends us are update_fails, failing the channel if not. It's probably
3826                 // easier to just fail the channel as this case should be rare enough anyway.
3827                 let height = self.best_block.height();
3828                 macro_rules! scan_commitment {
3829                         ($htlcs: expr, $holder_tx: expr) => {
3830                                 for ref htlc in $htlcs {
3831                                         // For inbound HTLCs which we know the preimage for, we have to ensure we hit the
3832                                         // chain with enough room to claim the HTLC without our counterparty being able to
3833                                         // time out the HTLC first.
3834                                         // For outbound HTLCs which our counterparty hasn't failed/claimed, our primary
3835                                         // concern is being able to claim the corresponding inbound HTLC (on another
3836                                         // channel) before it expires. In fact, we don't even really care if our
3837                                         // counterparty here claims such an outbound HTLC after it expired as long as we
3838                                         // can still claim the corresponding HTLC. Thus, to avoid needlessly hitting the
3839                                         // chain when our counterparty is waiting for expiration to off-chain fail an HTLC
3840                                         // we give ourselves a few blocks of headroom after expiration before going
3841                                         // on-chain for an expired HTLC.
3842                                         // Note that, to avoid a potential attack whereby a node delays claiming an HTLC
3843                                         // from us until we've reached the point where we go on-chain with the
3844                                         // corresponding inbound HTLC, we must ensure that outbound HTLCs go on chain at
3845                                         // least CLTV_CLAIM_BUFFER blocks prior to the inbound HTLC.
3846                                         //  aka outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS == height - CLTV_CLAIM_BUFFER
3847                                         //      inbound_cltv == height + CLTV_CLAIM_BUFFER
3848                                         //      outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS + CLTV_CLAIM_BUFFER <= inbound_cltv - CLTV_CLAIM_BUFFER
3849                                         //      LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= inbound_cltv - outbound_cltv
3850                                         //      CLTV_EXPIRY_DELTA <= inbound_cltv - outbound_cltv (by check in ChannelManager::decode_update_add_htlc_onion)
3851                                         //      LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= CLTV_EXPIRY_DELTA
3852                                         //  The final, above, condition is checked for statically in channelmanager
3853                                         //  with CHECK_CLTV_EXPIRY_SANITY_2.
3854                                         let htlc_outbound = $holder_tx == htlc.offered;
3855                                         if ( htlc_outbound && htlc.cltv_expiry + LATENCY_GRACE_PERIOD_BLOCKS <= height) ||
3856                                            (!htlc_outbound && htlc.cltv_expiry <= height + CLTV_CLAIM_BUFFER && self.payment_preimages.contains_key(&htlc.payment_hash)) {
3857                                                 log_info!(logger, "Force-closing channel due to {} HTLC timeout, HTLC expiry is {}", if htlc_outbound { "outbound" } else { "inbound "}, htlc.cltv_expiry);
3858                                                 return true;
3859                                         }
3860                                 }
3861                         }
3862                 }
3863
3864                 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
3865
3866                 if let Some(ref txid) = self.current_counterparty_commitment_txid {
3867                         if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
3868                                 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
3869                         }
3870                 }
3871                 if let Some(ref txid) = self.prev_counterparty_commitment_txid {
3872                         if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(txid) {
3873                                 scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
3874                         }
3875                 }
3876
3877                 false
3878         }
3879
3880         /// Check if any transaction broadcasted is resolving HTLC output by a success or timeout on a holder
3881         /// or counterparty commitment tx, if so send back the source, preimage if found and payment_hash of resolved HTLC
3882         fn is_resolving_htlc_output<L: Deref>(&mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L) where L::Target: Logger {
3883                 'outer_loop: for input in &tx.input {
3884                         let mut payment_data = None;
3885                         let htlc_claim = HTLCClaim::from_witness(&input.witness);
3886                         let revocation_sig_claim = htlc_claim == Some(HTLCClaim::Revocation);
3887                         let accepted_preimage_claim = htlc_claim == Some(HTLCClaim::AcceptedPreimage);
3888                         #[cfg(not(fuzzing))]
3889                         let accepted_timeout_claim = htlc_claim == Some(HTLCClaim::AcceptedTimeout);
3890                         let offered_preimage_claim = htlc_claim == Some(HTLCClaim::OfferedPreimage);
3891                         #[cfg(not(fuzzing))]
3892                         let offered_timeout_claim = htlc_claim == Some(HTLCClaim::OfferedTimeout);
3893
3894                         let mut payment_preimage = PaymentPreimage([0; 32]);
3895                         if offered_preimage_claim || accepted_preimage_claim {
3896                                 payment_preimage.0.copy_from_slice(input.witness.second_to_last().unwrap());
3897                         }
3898
3899                         macro_rules! log_claim {
3900                                 ($tx_info: expr, $holder_tx: expr, $htlc: expr, $source_avail: expr) => {
3901                                         let outbound_htlc = $holder_tx == $htlc.offered;
3902                                         // HTLCs must either be claimed by a matching script type or through the
3903                                         // revocation path:
3904                                         #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3905                                         debug_assert!(!$htlc.offered || offered_preimage_claim || offered_timeout_claim || revocation_sig_claim);
3906                                         #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3907                                         debug_assert!($htlc.offered || accepted_preimage_claim || accepted_timeout_claim || revocation_sig_claim);
3908                                         // Further, only exactly one of the possible spend paths should have been
3909                                         // matched by any HTLC spend:
3910                                         #[cfg(not(fuzzing))] // Note that the fuzzer is not bound by pesky things like "signatures"
3911                                         debug_assert_eq!(accepted_preimage_claim as u8 + accepted_timeout_claim as u8 +
3912                                                          offered_preimage_claim as u8 + offered_timeout_claim as u8 +
3913                                                          revocation_sig_claim as u8, 1);
3914                                         if ($holder_tx && revocation_sig_claim) ||
3915                                                         (outbound_htlc && !$source_avail && (accepted_preimage_claim || offered_preimage_claim)) {
3916                                                 log_error!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}!",
3917                                                         $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
3918                                                         if outbound_htlc { "outbound" } else { "inbound" }, &$htlc.payment_hash,
3919                                                         if revocation_sig_claim { "revocation sig" } else { "preimage claim after we'd passed the HTLC resolution back. We can likely claim the HTLC output with a revocation claim" });
3920                                         } else {
3921                                                 log_info!(logger, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}",
3922                                                         $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
3923                                                         if outbound_htlc { "outbound" } else { "inbound" }, &$htlc.payment_hash,
3924                                                         if revocation_sig_claim { "revocation sig" } else if accepted_preimage_claim || offered_preimage_claim { "preimage" } else { "timeout" });
3925                                         }
3926                                 }
3927                         }
3928
3929                         macro_rules! check_htlc_valid_counterparty {
3930                                 ($counterparty_txid: expr, $htlc_output: expr) => {
3931                                         if let Some(txid) = $counterparty_txid {
3932                                                 for &(ref pending_htlc, ref pending_source) in self.counterparty_claimable_outpoints.get(&txid).unwrap() {
3933                                                         if pending_htlc.payment_hash == $htlc_output.payment_hash && pending_htlc.amount_msat == $htlc_output.amount_msat {
3934                                                                 if let &Some(ref source) = pending_source {
3935                                                                         log_claim!("revoked counterparty commitment tx", false, pending_htlc, true);
3936                                                                         payment_data = Some(((**source).clone(), $htlc_output.payment_hash, $htlc_output.amount_msat));
3937                                                                         break;
3938                                                                 }
3939                                                         }
3940                                                 }
3941                                         }
3942                                 }
3943                         }
3944
3945                         macro_rules! scan_commitment {
3946                                 ($htlcs: expr, $tx_info: expr, $holder_tx: expr) => {
3947                                         for (ref htlc_output, source_option) in $htlcs {
3948                                                 if Some(input.previous_output.vout) == htlc_output.transaction_output_index {
3949                                                         if let Some(ref source) = source_option {
3950                                                                 log_claim!($tx_info, $holder_tx, htlc_output, true);
3951                                                                 // We have a resolution of an HTLC either from one of our latest
3952                                                                 // holder commitment transactions or an unrevoked counterparty commitment
3953                                                                 // transaction. This implies we either learned a preimage, the HTLC
3954                                                                 // has timed out, or we screwed up. In any case, we should now
3955                                                                 // resolve the source HTLC with the original sender.
3956                                                                 payment_data = Some(((*source).clone(), htlc_output.payment_hash, htlc_output.amount_msat));
3957                                                         } else if !$holder_tx {
3958                                                                 check_htlc_valid_counterparty!(self.current_counterparty_commitment_txid, htlc_output);
3959                                                                 if payment_data.is_none() {
3960                                                                         check_htlc_valid_counterparty!(self.prev_counterparty_commitment_txid, htlc_output);
3961                                                                 }
3962                                                         }
3963                                                         if payment_data.is_none() {
3964                                                                 log_claim!($tx_info, $holder_tx, htlc_output, false);
3965                                                                 let outbound_htlc = $holder_tx == htlc_output.offered;
3966                                                                 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
3967                                                                         txid: tx.txid(), height, block_hash: Some(*block_hash), transaction: Some(tx.clone()),
3968                                                                         event: OnchainEvent::HTLCSpendConfirmation {
3969                                                                                 commitment_tx_output_idx: input.previous_output.vout,
3970                                                                                 preimage: if accepted_preimage_claim || offered_preimage_claim {
3971                                                                                         Some(payment_preimage) } else { None },
3972                                                                                 // If this is a payment to us (ie !outbound_htlc), wait for
3973                                                                                 // the CSV delay before dropping the HTLC from claimable
3974                                                                                 // balance if the claim was an HTLC-Success transaction (ie
3975                                                                                 // accepted_preimage_claim).
3976                                                                                 on_to_local_output_csv: if accepted_preimage_claim && !outbound_htlc {
3977                                                                                         Some(self.on_holder_tx_csv) } else { None },
3978                                                                         },
3979                                                                 });
3980                                                                 continue 'outer_loop;
3981                                                         }
3982                                                 }
3983                                         }
3984                                 }
3985                         }
3986
3987                         if input.previous_output.txid == self.current_holder_commitment_tx.txid {
3988                                 scan_commitment!(self.current_holder_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
3989                                         "our latest holder commitment tx", true);
3990                         }
3991                         if let Some(ref prev_holder_signed_commitment_tx) = self.prev_holder_signed_commitment_tx {
3992                                 if input.previous_output.txid == prev_holder_signed_commitment_tx.txid {
3993                                         scan_commitment!(prev_holder_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
3994                                                 "our previous holder commitment tx", true);
3995                                 }
3996                         }
3997                         if let Some(ref htlc_outputs) = self.counterparty_claimable_outpoints.get(&input.previous_output.txid) {
3998                                 scan_commitment!(htlc_outputs.iter().map(|&(ref a, ref b)| (a, (b.as_ref().clone()).map(|boxed| &**boxed))),
3999                                         "counterparty commitment tx", false);
4000                         }
4001
4002                         // Check that scan_commitment, above, decided there is some source worth relaying an
4003                         // HTLC resolution backwards to and figure out whether we learned a preimage from it.
4004                         if let Some((source, payment_hash, amount_msat)) = payment_data {
4005                                 if accepted_preimage_claim {
4006                                         if !self.pending_monitor_events.iter().any(
4007                                                 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update { upd.source == source } else { false }) {
4008                                                 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
4009                                                         txid: tx.txid(),
4010                                                         height,
4011                                                         block_hash: Some(*block_hash),
4012                                                         transaction: Some(tx.clone()),
4013                                                         event: OnchainEvent::HTLCSpendConfirmation {
4014                                                                 commitment_tx_output_idx: input.previous_output.vout,
4015                                                                 preimage: Some(payment_preimage),
4016                                                                 on_to_local_output_csv: None,
4017                                                         },
4018                                                 });
4019                                                 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
4020                                                         source,
4021                                                         payment_preimage: Some(payment_preimage),
4022                                                         payment_hash,
4023                                                         htlc_value_satoshis: Some(amount_msat / 1000),
4024                                                 }));
4025                                         }
4026                                 } else if offered_preimage_claim {
4027                                         if !self.pending_monitor_events.iter().any(
4028                                                 |update| if let &MonitorEvent::HTLCEvent(ref upd) = update {
4029                                                         upd.source == source
4030                                                 } else { false }) {
4031                                                 self.onchain_events_awaiting_threshold_conf.push(OnchainEventEntry {
4032                                                         txid: tx.txid(),
4033                                                         transaction: Some(tx.clone()),
4034                                                         height,
4035                                                         block_hash: Some(*block_hash),
4036                                                         event: OnchainEvent::HTLCSpendConfirmation {
4037                                                                 commitment_tx_output_idx: input.previous_output.vout,
4038                                                                 preimage: Some(payment_preimage),
4039                                                                 on_to_local_output_csv: None,
4040                                                         },
4041                                                 });
4042                                                 self.pending_monitor_events.push(MonitorEvent::HTLCEvent(HTLCUpdate {
4043                                                         source,
4044                                                         payment_preimage: Some(payment_preimage),
4045                                                         payment_hash,
4046                                                         htlc_value_satoshis: Some(amount_msat / 1000),
4047                                                 }));
4048                                         }
4049                                 } else {
4050                                         self.onchain_events_awaiting_threshold_conf.retain(|ref entry| {
4051                                                 if entry.height != height { return true; }
4052                                                 match entry.event {
4053                                                         OnchainEvent::HTLCUpdate { source: ref htlc_source, .. } => {
4054                                                                 *htlc_source != source
4055                                                         },
4056                                                         _ => true,
4057                                                 }
4058                                         });
4059                                         let entry = OnchainEventEntry {
4060                                                 txid: tx.txid(),
4061                                                 transaction: Some(tx.clone()),
4062                                                 height,
4063                                                 block_hash: Some(*block_hash),
4064                                                 event: OnchainEvent::HTLCUpdate {
4065                                                         source, payment_hash,
4066                                                         htlc_value_satoshis: Some(amount_msat / 1000),
4067                                                         commitment_tx_output_idx: Some(input.previous_output.vout),
4068                                                 },
4069                                         };
4070                                         log_info!(logger, "Failing HTLC with payment_hash {} timeout by a spend tx, waiting for confirmation (at height {})", &payment_hash, entry.confirmation_threshold());
4071                                         self.onchain_events_awaiting_threshold_conf.push(entry);
4072                                 }
4073                         }
4074                 }
4075         }
4076
4077         fn get_spendable_outputs(&self, tx: &Transaction) -> Vec<SpendableOutputDescriptor> {
4078                 let mut spendable_outputs = Vec::new();
4079                 for (i, outp) in tx.output.iter().enumerate() {
4080                         if outp.script_pubkey == self.destination_script {
4081                                 spendable_outputs.push(SpendableOutputDescriptor::StaticOutput {
4082                                         outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
4083                                         output: outp.clone(),
4084                                 });
4085                         }
4086                         if let Some(ref broadcasted_holder_revokable_script) = self.broadcasted_holder_revokable_script {
4087                                 if broadcasted_holder_revokable_script.0 == outp.script_pubkey {
4088                                         spendable_outputs.push(SpendableOutputDescriptor::DelayedPaymentOutput(DelayedPaymentOutputDescriptor {
4089                                                 outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
4090                                                 per_commitment_point: broadcasted_holder_revokable_script.1,
4091                                                 to_self_delay: self.on_holder_tx_csv,
4092                                                 output: outp.clone(),
4093                                                 revocation_pubkey: broadcasted_holder_revokable_script.2.clone(),
4094                                                 channel_keys_id: self.channel_keys_id,
4095                                                 channel_value_satoshis: self.channel_value_satoshis,
4096                                         }));
4097                                 }
4098                         }
4099                         if self.counterparty_payment_script == outp.script_pubkey {
4100                                 spendable_outputs.push(SpendableOutputDescriptor::StaticPaymentOutput(StaticPaymentOutputDescriptor {
4101                                         outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
4102                                         output: outp.clone(),
4103                                         channel_keys_id: self.channel_keys_id,
4104                                         channel_value_satoshis: self.channel_value_satoshis,
4105                                         channel_transaction_parameters: Some(self.onchain_tx_handler.channel_transaction_parameters.clone()),
4106                                 }));
4107                         }
4108                         if self.shutdown_script.as_ref() == Some(&outp.script_pubkey) {
4109                                 spendable_outputs.push(SpendableOutputDescriptor::StaticOutput {
4110                                         outpoint: OutPoint { txid: tx.txid(), index: i as u16 },
4111                                         output: outp.clone(),
4112                                 });
4113                         }
4114                 }
4115                 spendable_outputs
4116         }
4117
4118         /// Checks if the confirmed transaction is paying funds back to some address we can assume to
4119         /// own.
4120         fn check_tx_and_push_spendable_outputs<L: Deref>(
4121                 &mut self, tx: &Transaction, height: u32, block_hash: &BlockHash, logger: &L,
4122         ) where L::Target: Logger {
4123                 for spendable_output in self.get_spendable_outputs(tx) {
4124                         let entry = OnchainEventEntry {
4125                                 txid: tx.txid(),
4126                                 transaction: Some(tx.clone()),
4127                                 height,
4128                                 block_hash: Some(*block_hash),
4129                                 event: OnchainEvent::MaturingOutput { descriptor: spendable_output.clone() },
4130                         };
4131                         log_info!(logger, "Received spendable output {}, spendable at height {}", log_spendable!(spendable_output), entry.confirmation_threshold());
4132                         self.onchain_events_awaiting_threshold_conf.push(entry);
4133                 }
4134         }
4135 }
4136
4137 impl<Signer: WriteableEcdsaChannelSigner, T: Deref, F: Deref, L: Deref> chain::Listen for (ChannelMonitor<Signer>, T, F, L)
4138 where
4139         T::Target: BroadcasterInterface,
4140         F::Target: FeeEstimator,
4141         L::Target: Logger,
4142 {
4143         fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
4144                 self.0.block_connected(header, txdata, height, &*self.1, &*self.2, &*self.3);
4145         }
4146
4147         fn block_disconnected(&self, header: &BlockHeader, height: u32) {
4148                 self.0.block_disconnected(header, height, &*self.1, &*self.2, &*self.3);
4149         }
4150 }
4151
4152 impl<Signer: WriteableEcdsaChannelSigner, M, T: Deref, F: Deref, L: Deref> chain::Confirm for (M, T, F, L)
4153 where
4154         M: Deref<Target = ChannelMonitor<Signer>>,
4155         T::Target: BroadcasterInterface,
4156         F::Target: FeeEstimator,
4157         L::Target: Logger,
4158 {
4159         fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
4160                 self.0.transactions_confirmed(header, txdata, height, &*self.1, &*self.2, &*self.3);
4161         }
4162
4163         fn transaction_unconfirmed(&self, txid: &Txid) {
4164                 self.0.transaction_unconfirmed(txid, &*self.1, &*self.2, &*self.3);
4165         }
4166
4167         fn best_block_updated(&self, header: &BlockHeader, height: u32) {
4168                 self.0.best_block_updated(header, height, &*self.1, &*self.2, &*self.3);
4169         }
4170
4171         fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
4172                 self.0.get_relevant_txids()
4173         }
4174 }
4175
4176 const MAX_ALLOC_SIZE: usize = 64*1024;
4177
4178 impl<'a, 'b, ES: EntropySource, SP: SignerProvider> ReadableArgs<(&'a ES, &'b SP)>
4179                 for (BlockHash, ChannelMonitor<SP::Signer>) {
4180         fn read<R: io::Read>(reader: &mut R, args: (&'a ES, &'b SP)) -> Result<Self, DecodeError> {
4181                 macro_rules! unwrap_obj {
4182                         ($key: expr) => {
4183                                 match $key {
4184                                         Ok(res) => res,
4185                                         Err(_) => return Err(DecodeError::InvalidValue),
4186                                 }
4187                         }
4188                 }
4189
4190                 let (entropy_source, signer_provider) = args;
4191
4192                 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
4193
4194                 let latest_update_id: u64 = Readable::read(reader)?;
4195                 let commitment_transaction_number_obscure_factor = <U48 as Readable>::read(reader)?.0;
4196
4197                 let destination_script = Readable::read(reader)?;
4198                 let broadcasted_holder_revokable_script = match <u8 as Readable>::read(reader)? {
4199                         0 => {
4200                                 let revokable_address = Readable::read(reader)?;
4201                                 let per_commitment_point = Readable::read(reader)?;
4202                                 let revokable_script = Readable::read(reader)?;
4203                                 Some((revokable_address, per_commitment_point, revokable_script))
4204                         },
4205                         1 => { None },
4206                         _ => return Err(DecodeError::InvalidValue),
4207                 };
4208                 let mut counterparty_payment_script: Script = Readable::read(reader)?;
4209                 let shutdown_script = {
4210                         let script = <Script as Readable>::read(reader)?;
4211                         if script.is_empty() { None } else { Some(script) }
4212                 };
4213
4214                 let channel_keys_id = Readable::read(reader)?;
4215                 let holder_revocation_basepoint = Readable::read(reader)?;
4216                 // Technically this can fail and serialize fail a round-trip, but only for serialization of
4217                 // barely-init'd ChannelMonitors that we can't do anything with.
4218                 let outpoint = OutPoint {
4219                         txid: Readable::read(reader)?,
4220                         index: Readable::read(reader)?,
4221                 };
4222                 let funding_info = (outpoint, Readable::read(reader)?);
4223                 let current_counterparty_commitment_txid = Readable::read(reader)?;
4224                 let prev_counterparty_commitment_txid = Readable::read(reader)?;
4225
4226                 let counterparty_commitment_params = Readable::read(reader)?;
4227                 let funding_redeemscript = Readable::read(reader)?;
4228                 let channel_value_satoshis = Readable::read(reader)?;
4229
4230                 let their_cur_per_commitment_points = {
4231                         let first_idx = <U48 as Readable>::read(reader)?.0;
4232                         if first_idx == 0 {
4233                                 None
4234                         } else {
4235                                 let first_point = Readable::read(reader)?;
4236                                 let second_point_slice: [u8; 33] = Readable::read(reader)?;
4237                                 if second_point_slice[0..32] == [0; 32] && second_point_slice[32] == 0 {
4238                                         Some((first_idx, first_point, None))
4239                                 } else {
4240                                         Some((first_idx, first_point, Some(unwrap_obj!(PublicKey::from_slice(&second_point_slice)))))
4241                                 }
4242                         }
4243                 };
4244
4245                 let on_holder_tx_csv: u16 = Readable::read(reader)?;
4246
4247                 let commitment_secrets = Readable::read(reader)?;
4248
4249                 macro_rules! read_htlc_in_commitment {
4250                         () => {
4251                                 {
4252                                         let offered: bool = Readable::read(reader)?;
4253                                         let amount_msat: u64 = Readable::read(reader)?;
4254                                         let cltv_expiry: u32 = Readable::read(reader)?;
4255                                         let payment_hash: PaymentHash = Readable::read(reader)?;
4256                                         let transaction_output_index: Option<u32> = Readable::read(reader)?;
4257
4258                                         HTLCOutputInCommitment {
4259                                                 offered, amount_msat, cltv_expiry, payment_hash, transaction_output_index
4260                                         }
4261                                 }
4262                         }
4263                 }
4264
4265                 let counterparty_claimable_outpoints_len: u64 = Readable::read(reader)?;
4266                 let mut counterparty_claimable_outpoints = HashMap::with_capacity(cmp::min(counterparty_claimable_outpoints_len as usize, MAX_ALLOC_SIZE / 64));
4267                 for _ in 0..counterparty_claimable_outpoints_len {
4268                         let txid: Txid = Readable::read(reader)?;
4269                         let htlcs_count: u64 = Readable::read(reader)?;
4270                         let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
4271                         for _ in 0..htlcs_count {
4272                                 htlcs.push((read_htlc_in_commitment!(), <Option<HTLCSource> as Readable>::read(reader)?.map(|o: HTLCSource| Box::new(o))));
4273                         }
4274                         if let Some(_) = counterparty_claimable_outpoints.insert(txid, htlcs) {
4275                                 return Err(DecodeError::InvalidValue);
4276                         }
4277                 }
4278
4279                 let counterparty_commitment_txn_on_chain_len: u64 = Readable::read(reader)?;
4280                 let mut counterparty_commitment_txn_on_chain = HashMap::with_capacity(cmp::min(counterparty_commitment_txn_on_chain_len as usize, MAX_ALLOC_SIZE / 32));
4281                 for _ in 0..counterparty_commitment_txn_on_chain_len {
4282                         let txid: Txid = Readable::read(reader)?;
4283                         let commitment_number = <U48 as Readable>::read(reader)?.0;
4284                         if let Some(_) = counterparty_commitment_txn_on_chain.insert(txid, commitment_number) {
4285                                 return Err(DecodeError::InvalidValue);
4286                         }
4287                 }
4288
4289                 let counterparty_hash_commitment_number_len: u64 = Readable::read(reader)?;
4290                 let mut counterparty_hash_commitment_number = HashMap::with_capacity(cmp::min(counterparty_hash_commitment_number_len as usize, MAX_ALLOC_SIZE / 32));
4291                 for _ in 0..counterparty_hash_commitment_number_len {
4292                         let payment_hash: PaymentHash = Readable::read(reader)?;
4293                         let commitment_number = <U48 as Readable>::read(reader)?.0;
4294                         if let Some(_) = counterparty_hash_commitment_number.insert(payment_hash, commitment_number) {
4295                                 return Err(DecodeError::InvalidValue);
4296                         }
4297                 }
4298
4299                 let mut prev_holder_signed_commitment_tx: Option<HolderSignedTx> =
4300                         match <u8 as Readable>::read(reader)? {
4301                                 0 => None,
4302                                 1 => {
4303                                         Some(Readable::read(reader)?)
4304                                 },
4305                                 _ => return Err(DecodeError::InvalidValue),
4306                         };
4307                 let mut current_holder_commitment_tx: HolderSignedTx = Readable::read(reader)?;
4308
4309                 let current_counterparty_commitment_number = <U48 as Readable>::read(reader)?.0;
4310                 let current_holder_commitment_number = <U48 as Readable>::read(reader)?.0;
4311
4312                 let payment_preimages_len: u64 = Readable::read(reader)?;
4313                 let mut payment_preimages = HashMap::with_capacity(cmp::min(payment_preimages_len as usize, MAX_ALLOC_SIZE / 32));
4314                 for _ in 0..payment_preimages_len {
4315                         let preimage: PaymentPreimage = Readable::read(reader)?;
4316                         let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
4317                         if let Some(_) = payment_preimages.insert(hash, preimage) {
4318                                 return Err(DecodeError::InvalidValue);
4319                         }
4320                 }
4321
4322                 let pending_monitor_events_len: u64 = Readable::read(reader)?;
4323                 let mut pending_monitor_events = Some(
4324                         Vec::with_capacity(cmp::min(pending_monitor_events_len as usize, MAX_ALLOC_SIZE / (32 + 8*3))));
4325                 for _ in 0..pending_monitor_events_len {
4326                         let ev = match <u8 as Readable>::read(reader)? {
4327                                 0 => MonitorEvent::HTLCEvent(Readable::read(reader)?),
4328                                 1 => MonitorEvent::HolderForceClosed(funding_info.0),
4329                                 _ => return Err(DecodeError::InvalidValue)
4330                         };
4331                         pending_monitor_events.as_mut().unwrap().push(ev);
4332                 }
4333
4334                 let pending_events_len: u64 = Readable::read(reader)?;
4335                 let mut pending_events = Vec::with_capacity(cmp::min(pending_events_len as usize, MAX_ALLOC_SIZE / mem::size_of::<Event>()));
4336                 for _ in 0..pending_events_len {
4337                         if let Some(event) = MaybeReadable::read(reader)? {
4338                                 pending_events.push(event);
4339                         }
4340                 }
4341
4342                 let best_block = BestBlock::new(Readable::read(reader)?, Readable::read(reader)?);
4343
4344                 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
4345                 let mut onchain_events_awaiting_threshold_conf = Vec::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
4346                 for _ in 0..waiting_threshold_conf_len {
4347                         if let Some(val) = MaybeReadable::read(reader)? {
4348                                 onchain_events_awaiting_threshold_conf.push(val);
4349                         }
4350                 }
4351
4352                 let outputs_to_watch_len: u64 = Readable::read(reader)?;
4353                 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>>())));
4354                 for _ in 0..outputs_to_watch_len {
4355                         let txid = Readable::read(reader)?;
4356                         let outputs_len: u64 = Readable::read(reader)?;
4357                         let mut outputs = Vec::with_capacity(cmp::min(outputs_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<u32>() + mem::size_of::<Script>())));
4358                         for _ in 0..outputs_len {
4359                                 outputs.push((Readable::read(reader)?, Readable::read(reader)?));
4360                         }
4361                         if let Some(_) = outputs_to_watch.insert(txid, outputs) {
4362                                 return Err(DecodeError::InvalidValue);
4363                         }
4364                 }
4365                 let onchain_tx_handler: OnchainTxHandler<SP::Signer> = ReadableArgs::read(
4366                         reader, (entropy_source, signer_provider, channel_value_satoshis, channel_keys_id)
4367                 )?;
4368
4369                 let lockdown_from_offchain = Readable::read(reader)?;
4370                 let holder_tx_signed = Readable::read(reader)?;
4371
4372                 if let Some(prev_commitment_tx) = prev_holder_signed_commitment_tx.as_mut() {
4373                         let prev_holder_value = onchain_tx_handler.get_prev_holder_commitment_to_self_value();
4374                         if prev_holder_value.is_none() { return Err(DecodeError::InvalidValue); }
4375                         if prev_commitment_tx.to_self_value_sat == u64::max_value() {
4376                                 prev_commitment_tx.to_self_value_sat = prev_holder_value.unwrap();
4377                         } else if prev_commitment_tx.to_self_value_sat != prev_holder_value.unwrap() {
4378                                 return Err(DecodeError::InvalidValue);
4379                         }
4380                 }
4381
4382                 let cur_holder_value = onchain_tx_handler.get_cur_holder_commitment_to_self_value();
4383                 if current_holder_commitment_tx.to_self_value_sat == u64::max_value() {
4384                         current_holder_commitment_tx.to_self_value_sat = cur_holder_value;
4385                 } else if current_holder_commitment_tx.to_self_value_sat != cur_holder_value {
4386                         return Err(DecodeError::InvalidValue);
4387                 }
4388
4389                 let mut funding_spend_confirmed = None;
4390                 let mut htlcs_resolved_on_chain = Some(Vec::new());
4391                 let mut funding_spend_seen = Some(false);
4392                 let mut counterparty_node_id = None;
4393                 let mut confirmed_commitment_tx_counterparty_output = None;
4394                 let mut spendable_txids_confirmed = Some(Vec::new());
4395                 let mut counterparty_fulfilled_htlcs = Some(HashMap::new());
4396                 let mut initial_counterparty_commitment_info = None;
4397                 read_tlv_fields!(reader, {
4398                         (1, funding_spend_confirmed, option),
4399                         (3, htlcs_resolved_on_chain, optional_vec),
4400                         (5, pending_monitor_events, optional_vec),
4401                         (7, funding_spend_seen, option),
4402                         (9, counterparty_node_id, option),
4403                         (11, confirmed_commitment_tx_counterparty_output, option),
4404                         (13, spendable_txids_confirmed, optional_vec),
4405                         (15, counterparty_fulfilled_htlcs, option),
4406                         (17, initial_counterparty_commitment_info, option),
4407                 });
4408
4409                 // Monitors for anchor outputs channels opened in v0.0.116 suffered from a bug in which the
4410                 // wrong `counterparty_payment_script` was being tracked. Fix it now on deserialization to
4411                 // give them a chance to recognize the spendable output.
4412                 if onchain_tx_handler.channel_type_features().supports_anchors_zero_fee_htlc_tx() &&
4413                         counterparty_payment_script.is_v0_p2wpkh()
4414                 {
4415                         let payment_point = onchain_tx_handler.channel_transaction_parameters.holder_pubkeys.payment_point;
4416                         counterparty_payment_script =
4417                                 chan_utils::get_to_countersignatory_with_anchors_redeemscript(&payment_point).to_v0_p2wsh();
4418                 }
4419
4420                 Ok((best_block.block_hash(), ChannelMonitor::from_impl(ChannelMonitorImpl {
4421                         latest_update_id,
4422                         commitment_transaction_number_obscure_factor,
4423
4424                         destination_script,
4425                         broadcasted_holder_revokable_script,
4426                         counterparty_payment_script,
4427                         shutdown_script,
4428
4429                         channel_keys_id,
4430                         holder_revocation_basepoint,
4431                         funding_info,
4432                         current_counterparty_commitment_txid,
4433                         prev_counterparty_commitment_txid,
4434
4435                         counterparty_commitment_params,
4436                         funding_redeemscript,
4437                         channel_value_satoshis,
4438                         their_cur_per_commitment_points,
4439
4440                         on_holder_tx_csv,
4441
4442                         commitment_secrets,
4443                         counterparty_claimable_outpoints,
4444                         counterparty_commitment_txn_on_chain,
4445                         counterparty_hash_commitment_number,
4446                         counterparty_fulfilled_htlcs: counterparty_fulfilled_htlcs.unwrap(),
4447
4448                         prev_holder_signed_commitment_tx,
4449                         current_holder_commitment_tx,
4450                         current_counterparty_commitment_number,
4451                         current_holder_commitment_number,
4452
4453                         payment_preimages,
4454                         pending_monitor_events: pending_monitor_events.unwrap(),
4455                         pending_events,
4456                         is_processing_pending_events: false,
4457
4458                         onchain_events_awaiting_threshold_conf,
4459                         outputs_to_watch,
4460
4461                         onchain_tx_handler,
4462
4463                         lockdown_from_offchain,
4464                         holder_tx_signed,
4465                         funding_spend_seen: funding_spend_seen.unwrap(),
4466                         funding_spend_confirmed,
4467                         confirmed_commitment_tx_counterparty_output,
4468                         htlcs_resolved_on_chain: htlcs_resolved_on_chain.unwrap(),
4469                         spendable_txids_confirmed: spendable_txids_confirmed.unwrap(),
4470
4471                         best_block,
4472                         counterparty_node_id,
4473                         initial_counterparty_commitment_info,
4474                 })))
4475         }
4476 }
4477
4478 #[cfg(test)]
4479 mod tests {
4480         use bitcoin::blockdata::script::{Script, Builder};
4481         use bitcoin::blockdata::opcodes;
4482         use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut, EcdsaSighashType};
4483         use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
4484         use bitcoin::util::sighash;
4485         use bitcoin::hashes::Hash;
4486         use bitcoin::hashes::sha256::Hash as Sha256;
4487         use bitcoin::hashes::hex::FromHex;
4488         use bitcoin::hash_types::{BlockHash, Txid};
4489         use bitcoin::network::constants::Network;
4490         use bitcoin::secp256k1::{SecretKey,PublicKey};
4491         use bitcoin::secp256k1::Secp256k1;
4492
4493         use hex;
4494
4495         use crate::chain::chaininterface::LowerBoundedFeeEstimator;
4496
4497         use super::ChannelMonitorUpdateStep;
4498         use crate::{check_added_monitors, check_spends, get_local_commitment_txn, get_monitor, get_route_and_payment_hash, unwrap_send_err};
4499         use crate::chain::{BestBlock, Confirm};
4500         use crate::chain::channelmonitor::ChannelMonitor;
4501         use crate::chain::package::{weight_offered_htlc, weight_received_htlc, weight_revoked_offered_htlc, weight_revoked_received_htlc, WEIGHT_REVOKED_OUTPUT};
4502         use crate::chain::transaction::OutPoint;
4503         use crate::sign::InMemorySigner;
4504         use crate::ln::{PaymentPreimage, PaymentHash};
4505         use crate::ln::chan_utils;
4506         use crate::ln::chan_utils::{HTLCOutputInCommitment, ChannelPublicKeys, ChannelTransactionParameters, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters};
4507         use crate::ln::channelmanager::{PaymentSendFailure, PaymentId, RecipientOnionFields};
4508         use crate::ln::functional_test_utils::*;
4509         use crate::ln::script::ShutdownScript;
4510         use crate::util::errors::APIError;
4511         use crate::util::test_utils::{TestLogger, TestBroadcaster, TestFeeEstimator};
4512         use crate::util::ser::{ReadableArgs, Writeable};
4513         use crate::sync::{Arc, Mutex};
4514         use crate::io;
4515         use bitcoin::{PackedLockTime, Sequence, Witness};
4516         use crate::ln::features::ChannelTypeFeatures;
4517         use crate::prelude::*;
4518
4519         fn do_test_funding_spend_refuses_updates(use_local_txn: bool) {
4520                 // Previously, monitor updates were allowed freely even after a funding-spend transaction
4521                 // confirmed. This would allow a race condition where we could receive a payment (including
4522                 // the counterparty revoking their broadcasted state!) and accept it without recourse as
4523                 // long as the ChannelMonitor receives the block first, the full commitment update dance
4524                 // occurs after the block is connected, and before the ChannelManager receives the block.
4525                 // Obviously this is an incredibly contrived race given the counterparty would be risking
4526                 // their full channel balance for it, but its worth fixing nonetheless as it makes the
4527                 // potential ChannelMonitor states simpler to reason about.
4528                 //
4529                 // This test checks said behavior, as well as ensuring a ChannelMonitorUpdate with multiple
4530                 // updates is handled correctly in such conditions.
4531                 let chanmon_cfgs = create_chanmon_cfgs(3);
4532                 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4533                 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4534                 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4535                 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
4536                 create_announced_chan_between_nodes(&nodes, 1, 2);
4537
4538                 // Rebalance somewhat
4539                 send_payment(&nodes[0], &[&nodes[1]], 10_000_000);
4540
4541                 // First route two payments for testing at the end
4542                 let payment_preimage_1 = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000).0;
4543                 let payment_preimage_2 = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000).0;
4544
4545                 let local_txn = get_local_commitment_txn!(nodes[1], channel.2);
4546                 assert_eq!(local_txn.len(), 1);
4547                 let remote_txn = get_local_commitment_txn!(nodes[0], channel.2);
4548                 assert_eq!(remote_txn.len(), 3); // Commitment and two HTLC-Timeouts
4549                 check_spends!(remote_txn[1], remote_txn[0]);
4550                 check_spends!(remote_txn[2], remote_txn[0]);
4551                 let broadcast_tx = if use_local_txn { &local_txn[0] } else { &remote_txn[0] };
4552
4553                 // Connect a commitment transaction, but only to the ChainMonitor/ChannelMonitor. The
4554                 // channel is now closed, but the ChannelManager doesn't know that yet.
4555                 let new_header = create_dummy_header(nodes[0].best_block_info().0, 0);
4556                 let conf_height = nodes[0].best_block_info().1 + 1;
4557                 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(&new_header,
4558                         &[(0, broadcast_tx)], conf_height);
4559
4560                 let (_, pre_update_monitor) = <(BlockHash, ChannelMonitor<InMemorySigner>)>::read(
4561                                                 &mut io::Cursor::new(&get_monitor!(nodes[1], channel.2).encode()),
4562                                                 (&nodes[1].keys_manager.backing, &nodes[1].keys_manager.backing)).unwrap();
4563
4564                 // If the ChannelManager tries to update the channel, however, the ChainMonitor will pass
4565                 // the update through to the ChannelMonitor which will refuse it (as the channel is closed).
4566                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 100_000);
4567                 unwrap_send_err!(nodes[1].node.send_payment_with_route(&route, payment_hash,
4568                                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
4569                         ), false, APIError::MonitorUpdateInProgress, {});
4570                 check_added_monitors!(nodes[1], 1);
4571
4572                 // Build a new ChannelMonitorUpdate which contains both the failing commitment tx update
4573                 // and provides the claim preimages for the two pending HTLCs. The first update generates
4574                 // an error, but the point of this test is to ensure the later updates are still applied.
4575                 let monitor_updates = nodes[1].chain_monitor.monitor_updates.lock().unwrap();
4576                 let mut replay_update = monitor_updates.get(&channel.2).unwrap().iter().rev().next().unwrap().clone();
4577                 assert_eq!(replay_update.updates.len(), 1);
4578                 if let ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo { .. } = replay_update.updates[0] {
4579                 } else { panic!(); }
4580                 replay_update.updates.push(ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage: payment_preimage_1 });
4581                 replay_update.updates.push(ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage: payment_preimage_2 });
4582
4583                 let broadcaster = TestBroadcaster::with_blocks(Arc::clone(&nodes[1].blocks));
4584                 assert!(
4585                         pre_update_monitor.update_monitor(&replay_update, &&broadcaster, &&chanmon_cfgs[1].fee_estimator, &nodes[1].logger)
4586                         .is_err());
4587                 // Even though we error'd on the first update, we should still have generated an HTLC claim
4588                 // transaction
4589                 let txn_broadcasted = broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4590                 assert!(txn_broadcasted.len() >= 2);
4591                 let htlc_txn = txn_broadcasted.iter().filter(|tx| {
4592                         assert_eq!(tx.input.len(), 1);
4593                         tx.input[0].previous_output.txid == broadcast_tx.txid()
4594                 }).collect::<Vec<_>>();
4595                 assert_eq!(htlc_txn.len(), 2);
4596                 check_spends!(htlc_txn[0], broadcast_tx);
4597                 check_spends!(htlc_txn[1], broadcast_tx);
4598         }
4599         #[test]
4600         fn test_funding_spend_refuses_updates() {
4601                 do_test_funding_spend_refuses_updates(true);
4602                 do_test_funding_spend_refuses_updates(false);
4603         }
4604
4605         #[test]
4606         fn test_prune_preimages() {
4607                 let secp_ctx = Secp256k1::new();
4608                 let logger = Arc::new(TestLogger::new());
4609                 let broadcaster = Arc::new(TestBroadcaster::new(Network::Testnet));
4610                 let fee_estimator = TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4611
4612                 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4613
4614                 let mut preimages = Vec::new();
4615                 {
4616                         for i in 0..20 {
4617                                 let preimage = PaymentPreimage([i; 32]);
4618                                 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
4619                                 preimages.push((preimage, hash));
4620                         }
4621                 }
4622
4623                 macro_rules! preimages_slice_to_htlcs {
4624                         ($preimages_slice: expr) => {
4625                                 {
4626                                         let mut res = Vec::new();
4627                                         for (idx, preimage) in $preimages_slice.iter().enumerate() {
4628                                                 res.push((HTLCOutputInCommitment {
4629                                                         offered: true,
4630                                                         amount_msat: 0,
4631                                                         cltv_expiry: 0,
4632                                                         payment_hash: preimage.1.clone(),
4633                                                         transaction_output_index: Some(idx as u32),
4634                                                 }, ()));
4635                                         }
4636                                         res
4637                                 }
4638                         }
4639                 }
4640                 macro_rules! preimages_slice_to_htlc_outputs {
4641                         ($preimages_slice: expr) => {
4642                                 preimages_slice_to_htlcs!($preimages_slice).into_iter().map(|(htlc, _)| (htlc, None)).collect()
4643                         }
4644                 }
4645                 let dummy_sig = crate::util::crypto::sign(&secp_ctx,
4646                         &bitcoin::secp256k1::Message::from_slice(&[42; 32]).unwrap(),
4647                         &SecretKey::from_slice(&[42; 32]).unwrap());
4648
4649                 macro_rules! test_preimages_exist {
4650                         ($preimages_slice: expr, $monitor: expr) => {
4651                                 for preimage in $preimages_slice {
4652                                         assert!($monitor.inner.lock().unwrap().payment_preimages.contains_key(&preimage.1));
4653                                 }
4654                         }
4655                 }
4656
4657                 let keys = InMemorySigner::new(
4658                         &secp_ctx,
4659                         SecretKey::from_slice(&[41; 32]).unwrap(),
4660                         SecretKey::from_slice(&[41; 32]).unwrap(),
4661                         SecretKey::from_slice(&[41; 32]).unwrap(),
4662                         SecretKey::from_slice(&[41; 32]).unwrap(),
4663                         SecretKey::from_slice(&[41; 32]).unwrap(),
4664                         [41; 32],
4665                         0,
4666                         [0; 32],
4667                         [0; 32],
4668                 );
4669
4670                 let counterparty_pubkeys = ChannelPublicKeys {
4671                         funding_pubkey: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[44; 32]).unwrap()),
4672                         revocation_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[45; 32]).unwrap()),
4673                         payment_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[46; 32]).unwrap()),
4674                         delayed_payment_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[47; 32]).unwrap()),
4675                         htlc_basepoint: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[48; 32]).unwrap())
4676                 };
4677                 let funding_outpoint = OutPoint { txid: Txid::all_zeros(), index: u16::max_value() };
4678                 let channel_parameters = ChannelTransactionParameters {
4679                         holder_pubkeys: keys.holder_channel_pubkeys.clone(),
4680                         holder_selected_contest_delay: 66,
4681                         is_outbound_from_holder: true,
4682                         counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
4683                                 pubkeys: counterparty_pubkeys,
4684                                 selected_contest_delay: 67,
4685                         }),
4686                         funding_outpoint: Some(funding_outpoint),
4687                         channel_type_features: ChannelTypeFeatures::only_static_remote_key()
4688                 };
4689                 // Prune with one old state and a holder commitment tx holding a few overlaps with the
4690                 // old state.
4691                 let shutdown_pubkey = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4692                 let best_block = BestBlock::from_network(Network::Testnet);
4693                 let monitor = ChannelMonitor::new(Secp256k1::new(), keys,
4694                         Some(ShutdownScript::new_p2wpkh_from_pubkey(shutdown_pubkey).into_inner()), 0, &Script::new(),
4695                         (OutPoint { txid: Txid::from_slice(&[43; 32]).unwrap(), index: 0 }, Script::new()),
4696                         &channel_parameters, Script::new(), 46, 0, HolderCommitmentTransaction::dummy(&mut Vec::new()),
4697                         best_block, dummy_key);
4698
4699                 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..10]);
4700                 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4701                 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx.clone(),
4702                         htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4703                 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"1").into_inner()),
4704                         preimages_slice_to_htlc_outputs!(preimages[5..15]), 281474976710655, dummy_key, &logger);
4705                 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"2").into_inner()),
4706                         preimages_slice_to_htlc_outputs!(preimages[15..20]), 281474976710654, dummy_key, &logger);
4707                 for &(ref preimage, ref hash) in preimages.iter() {
4708                         let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&fee_estimator);
4709                         monitor.provide_payment_preimage(hash, preimage, &broadcaster, &bounded_fee_estimator, &logger);
4710                 }
4711
4712                 // Now provide a secret, pruning preimages 10-15
4713                 let mut secret = [0; 32];
4714                 secret[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
4715                 monitor.provide_secret(281474976710655, secret.clone()).unwrap();
4716                 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 15);
4717                 test_preimages_exist!(&preimages[0..10], monitor);
4718                 test_preimages_exist!(&preimages[15..20], monitor);
4719
4720                 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"3").into_inner()),
4721                         preimages_slice_to_htlc_outputs!(preimages[17..20]), 281474976710653, dummy_key, &logger);
4722
4723                 // Now provide a further secret, pruning preimages 15-17
4724                 secret[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
4725                 monitor.provide_secret(281474976710654, secret.clone()).unwrap();
4726                 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 13);
4727                 test_preimages_exist!(&preimages[0..10], monitor);
4728                 test_preimages_exist!(&preimages[17..20], monitor);
4729
4730                 monitor.provide_latest_counterparty_commitment_tx(Txid::from_inner(Sha256::hash(b"4").into_inner()),
4731                         preimages_slice_to_htlc_outputs!(preimages[18..20]), 281474976710652, dummy_key, &logger);
4732
4733                 // Now update holder commitment tx info, pruning only element 18 as we still care about the
4734                 // previous commitment tx's preimages too
4735                 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..5]);
4736                 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4737                 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx.clone(),
4738                         htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4739                 secret[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
4740                 monitor.provide_secret(281474976710653, secret.clone()).unwrap();
4741                 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 12);
4742                 test_preimages_exist!(&preimages[0..10], monitor);
4743                 test_preimages_exist!(&preimages[18..20], monitor);
4744
4745                 // But if we do it again, we'll prune 5-10
4746                 let mut htlcs = preimages_slice_to_htlcs!(preimages[0..3]);
4747                 let dummy_commitment_tx = HolderCommitmentTransaction::dummy(&mut htlcs);
4748                 monitor.provide_latest_holder_commitment_tx(dummy_commitment_tx,
4749                         htlcs.into_iter().map(|(htlc, _)| (htlc, Some(dummy_sig), None)).collect()).unwrap();
4750                 secret[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
4751                 monitor.provide_secret(281474976710652, secret.clone()).unwrap();
4752                 assert_eq!(monitor.inner.lock().unwrap().payment_preimages.len(), 5);
4753                 test_preimages_exist!(&preimages[0..5], monitor);
4754         }
4755
4756         #[test]
4757         fn test_claim_txn_weight_computation() {
4758                 // We test Claim txn weight, knowing that we want expected weigth and
4759                 // not actual case to avoid sigs and time-lock delays hell variances.
4760
4761                 let secp_ctx = Secp256k1::new();
4762                 let privkey = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
4763                 let pubkey = PublicKey::from_secret_key(&secp_ctx, &privkey);
4764
4765                 macro_rules! sign_input {
4766                         ($sighash_parts: expr, $idx: expr, $amount: expr, $weight: expr, $sum_actual_sigs: expr, $opt_anchors: expr) => {
4767                                 let htlc = HTLCOutputInCommitment {
4768                                         offered: if *$weight == weight_revoked_offered_htlc($opt_anchors) || *$weight == weight_offered_htlc($opt_anchors) { true } else { false },
4769                                         amount_msat: 0,
4770                                         cltv_expiry: 2 << 16,
4771                                         payment_hash: PaymentHash([1; 32]),
4772                                         transaction_output_index: Some($idx as u32),
4773                                 };
4774                                 let redeem_script = if *$weight == WEIGHT_REVOKED_OUTPUT { chan_utils::get_revokeable_redeemscript(&pubkey, 256, &pubkey) } else { chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, $opt_anchors, &pubkey, &pubkey, &pubkey) };
4775                                 let sighash = hash_to_message!(&$sighash_parts.segwit_signature_hash($idx, &redeem_script, $amount, EcdsaSighashType::All).unwrap()[..]);
4776                                 let sig = secp_ctx.sign_ecdsa(&sighash, &privkey);
4777                                 let mut ser_sig = sig.serialize_der().to_vec();
4778                                 ser_sig.push(EcdsaSighashType::All as u8);
4779                                 $sum_actual_sigs += ser_sig.len();
4780                                 let witness = $sighash_parts.witness_mut($idx).unwrap();
4781                                 witness.push(ser_sig);
4782                                 if *$weight == WEIGHT_REVOKED_OUTPUT {
4783                                         witness.push(vec!(1));
4784                                 } else if *$weight == weight_revoked_offered_htlc($opt_anchors) || *$weight == weight_revoked_received_htlc($opt_anchors) {
4785                                         witness.push(pubkey.clone().serialize().to_vec());
4786                                 } else if *$weight == weight_received_htlc($opt_anchors) {
4787                                         witness.push(vec![0]);
4788                                 } else {
4789                                         witness.push(PaymentPreimage([1; 32]).0.to_vec());
4790                                 }
4791                                 witness.push(redeem_script.into_bytes());
4792                                 let witness = witness.to_vec();
4793                                 println!("witness[0] {}", witness[0].len());
4794                                 println!("witness[1] {}", witness[1].len());
4795                                 println!("witness[2] {}", witness[2].len());
4796                         }
4797                 }
4798
4799                 let script_pubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script();
4800                 let txid = Txid::from_hex("56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d").unwrap();
4801
4802                 // Justice tx with 1 to_holder, 2 revoked offered HTLCs, 1 revoked received HTLCs
4803                 for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
4804                         let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4805                         let mut sum_actual_sigs = 0;
4806                         for i in 0..4 {
4807                                 claim_tx.input.push(TxIn {
4808                                         previous_output: BitcoinOutPoint {
4809                                                 txid,
4810                                                 vout: i,
4811                                         },
4812                                         script_sig: Script::new(),
4813                                         sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4814                                         witness: Witness::new(),
4815                                 });
4816                         }
4817                         claim_tx.output.push(TxOut {
4818                                 script_pubkey: script_pubkey.clone(),
4819                                 value: 0,
4820                         });
4821                         let base_weight = claim_tx.weight();
4822                         let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT, weight_revoked_offered_htlc(channel_type_features), weight_revoked_offered_htlc(channel_type_features), weight_revoked_received_htlc(channel_type_features)];
4823                         let mut inputs_total_weight = 2; // count segwit flags
4824                         {
4825                                 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4826                                 for (idx, inp) in inputs_weight.iter().enumerate() {
4827                                         sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, channel_type_features);
4828                                         inputs_total_weight += inp;
4829                                 }
4830                         }
4831                         assert_eq!(base_weight + inputs_total_weight as usize,  claim_tx.weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
4832                 }
4833
4834                 // Claim tx with 1 offered HTLCs, 3 received HTLCs
4835                 for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
4836                         let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4837                         let mut sum_actual_sigs = 0;
4838                         for i in 0..4 {
4839                                 claim_tx.input.push(TxIn {
4840                                         previous_output: BitcoinOutPoint {
4841                                                 txid,
4842                                                 vout: i,
4843                                         },
4844                                         script_sig: Script::new(),
4845                                         sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4846                                         witness: Witness::new(),
4847                                 });
4848                         }
4849                         claim_tx.output.push(TxOut {
4850                                 script_pubkey: script_pubkey.clone(),
4851                                 value: 0,
4852                         });
4853                         let base_weight = claim_tx.weight();
4854                         let inputs_weight = vec![weight_offered_htlc(channel_type_features), weight_received_htlc(channel_type_features), weight_received_htlc(channel_type_features), weight_received_htlc(channel_type_features)];
4855                         let mut inputs_total_weight = 2; // count segwit flags
4856                         {
4857                                 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4858                                 for (idx, inp) in inputs_weight.iter().enumerate() {
4859                                         sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, channel_type_features);
4860                                         inputs_total_weight += inp;
4861                                 }
4862                         }
4863                         assert_eq!(base_weight + inputs_total_weight as usize,  claim_tx.weight() + /* max_length_sig */ (73 * inputs_weight.len() - sum_actual_sigs));
4864                 }
4865
4866                 // Justice tx with 1 revoked HTLC-Success tx output
4867                 for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
4868                         let mut claim_tx = Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() };
4869                         let mut sum_actual_sigs = 0;
4870                         claim_tx.input.push(TxIn {
4871                                 previous_output: BitcoinOutPoint {
4872                                         txid,
4873                                         vout: 0,
4874                                 },
4875                                 script_sig: Script::new(),
4876                                 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
4877                                 witness: Witness::new(),
4878                         });
4879                         claim_tx.output.push(TxOut {
4880                                 script_pubkey: script_pubkey.clone(),
4881                                 value: 0,
4882                         });
4883                         let base_weight = claim_tx.weight();
4884                         let inputs_weight = vec![WEIGHT_REVOKED_OUTPUT];
4885                         let mut inputs_total_weight = 2; // count segwit flags
4886                         {
4887                                 let mut sighash_parts = sighash::SighashCache::new(&mut claim_tx);
4888                                 for (idx, inp) in inputs_weight.iter().enumerate() {
4889                                         sign_input!(sighash_parts, idx, 0, inp, sum_actual_sigs, channel_type_features);
4890                                         inputs_total_weight += inp;
4891                                 }
4892                         }
4893                         assert_eq!(base_weight + inputs_total_weight as usize, claim_tx.weight() + /* max_length_isg */ (73 * inputs_weight.len() - sum_actual_sigs));
4894                 }
4895         }
4896
4897         // Further testing is done in the ChannelManager integration tests.
4898 }