Rename keys for OnchainTxHandler::claimable_outpoints map
[rust-lightning] / lightning / src / chain / onchaintx.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 build claims and bump in-flight transactions until confirmations.
11 //!
12 //! OnchainTxHandler objects are fully-part of ChannelMonitor and encapsulates all
13 //! building, tracking, bumping and notifications functions.
14
15 use bitcoin::blockdata::transaction::Transaction;
16 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
17 use bitcoin::blockdata::script::Script;
18
19 use bitcoin::hash_types::{Txid, BlockHash};
20
21 use bitcoin::secp256k1::{Secp256k1, ecdsa::Signature};
22 use bitcoin::secp256k1;
23
24 use crate::chain::keysinterface::{ChannelSigner, EntropySource, SignerProvider};
25 use crate::ln::msgs::DecodeError;
26 use crate::ln::PaymentPreimage;
27 #[cfg(anchors)]
28 use crate::ln::chan_utils::{self, HTLCOutputInCommitment};
29 use crate::ln::chan_utils::{ChannelTransactionParameters, HolderCommitmentTransaction};
30 #[cfg(anchors)]
31 use crate::chain::chaininterface::ConfirmationTarget;
32 use crate::chain::chaininterface::{FeeEstimator, BroadcasterInterface, LowerBoundedFeeEstimator};
33 use crate::chain::channelmonitor::{ANTI_REORG_DELAY, CLTV_SHARED_CLAIM_BUFFER};
34 use crate::chain::keysinterface::WriteableEcdsaChannelSigner;
35 #[cfg(anchors)]
36 use crate::chain::package::PackageSolvingData;
37 use crate::chain::package::PackageTemplate;
38 use crate::util::logger::Logger;
39 use crate::util::ser::{Readable, ReadableArgs, MaybeReadable, UpgradableRequired, Writer, Writeable, VecWriter};
40
41 use crate::io;
42 use crate::prelude::*;
43 use alloc::collections::BTreeMap;
44 use core::cmp;
45 use core::ops::Deref;
46 use core::mem::replace;
47 #[cfg(anchors)]
48 use core::mem::swap;
49 use bitcoin::hashes::Hash;
50
51 const MAX_ALLOC_SIZE: usize = 64*1024;
52
53 /// An entry for an [`OnchainEvent`], stating the block height when the event was observed and the
54 /// transaction causing it.
55 ///
56 /// Used to determine when the on-chain event can be considered safe from a chain reorganization.
57 #[derive(PartialEq, Eq)]
58 struct OnchainEventEntry {
59         txid: Txid,
60         height: u32,
61         block_hash: Option<BlockHash>, // Added as optional, will be filled in for any entry generated on 0.0.113 or after
62         event: OnchainEvent,
63 }
64
65 impl OnchainEventEntry {
66         fn confirmation_threshold(&self) -> u32 {
67                 self.height + ANTI_REORG_DELAY - 1
68         }
69
70         fn has_reached_confirmation_threshold(&self, height: u32) -> bool {
71                 height >= self.confirmation_threshold()
72         }
73 }
74
75 /// Events for claims the [`OnchainTxHandler`] has generated. Once the events are considered safe
76 /// from a chain reorg, the [`OnchainTxHandler`] will act accordingly.
77 #[derive(PartialEq, Eq)]
78 enum OnchainEvent {
79         /// A pending request has been claimed by a transaction spending the exact same set of outpoints
80         /// as the request. This claim can either be ours or from the counterparty. Once the claiming
81         /// transaction has met [`ANTI_REORG_DELAY`] confirmations, we consider it final and remove the
82         /// pending request.
83         Claim {
84                 package_id: PackageID,
85         },
86         /// The counterparty has claimed an outpoint from one of our pending requests through a
87         /// different transaction than ours. If our transaction was attempting to claim multiple
88         /// outputs, we need to drop the outpoint claimed by the counterparty and regenerate a new claim
89         /// transaction for ourselves. We keep tracking, separately, the outpoint claimed by the
90         /// counterparty up to [`ANTI_REORG_DELAY`] confirmations to ensure we attempt to re-claim it
91         /// if the counterparty's claim is reorged from the chain.
92         ContentiousOutpoint {
93                 package: PackageTemplate,
94         }
95 }
96
97 impl Writeable for OnchainEventEntry {
98         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
99                 write_tlv_fields!(writer, {
100                         (0, self.txid, required),
101                         (1, self.block_hash, option),
102                         (2, self.height, required),
103                         (4, self.event, required),
104                 });
105                 Ok(())
106         }
107 }
108
109 impl MaybeReadable for OnchainEventEntry {
110         fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, DecodeError> {
111                 let mut txid = Txid::all_zeros();
112                 let mut height = 0;
113                 let mut block_hash = None;
114                 let mut event = UpgradableRequired(None);
115                 read_tlv_fields!(reader, {
116                         (0, txid, required),
117                         (1, block_hash, option),
118                         (2, height, required),
119                         (4, event, upgradable_required),
120                 });
121                 Ok(Some(Self { txid, height, block_hash, event: _init_tlv_based_struct_field!(event, upgradable_required) }))
122         }
123 }
124
125 impl_writeable_tlv_based_enum_upgradable!(OnchainEvent,
126         (0, Claim) => {
127                 (0, package_id, required),
128         },
129         (1, ContentiousOutpoint) => {
130                 (0, package, required),
131         },
132 );
133
134 impl Readable for Option<Vec<Option<(usize, Signature)>>> {
135         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
136                 match Readable::read(reader)? {
137                         0u8 => Ok(None),
138                         1u8 => {
139                                 let vlen: u64 = Readable::read(reader)?;
140                                 let mut ret = Vec::with_capacity(cmp::min(vlen as usize, MAX_ALLOC_SIZE / ::core::mem::size_of::<Option<(usize, Signature)>>()));
141                                 for _ in 0..vlen {
142                                         ret.push(match Readable::read(reader)? {
143                                                 0u8 => None,
144                                                 1u8 => Some((<u64 as Readable>::read(reader)? as usize, Readable::read(reader)?)),
145                                                 _ => return Err(DecodeError::InvalidValue)
146                                         });
147                                 }
148                                 Ok(Some(ret))
149                         },
150                         _ => Err(DecodeError::InvalidValue),
151                 }
152         }
153 }
154
155 impl Writeable for Option<Vec<Option<(usize, Signature)>>> {
156         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
157                 match self {
158                         &Some(ref vec) => {
159                                 1u8.write(writer)?;
160                                 (vec.len() as u64).write(writer)?;
161                                 for opt in vec.iter() {
162                                         match opt {
163                                                 &Some((ref idx, ref sig)) => {
164                                                         1u8.write(writer)?;
165                                                         (*idx as u64).write(writer)?;
166                                                         sig.write(writer)?;
167                                                 },
168                                                 &None => 0u8.write(writer)?,
169                                         }
170                                 }
171                         },
172                         &None => 0u8.write(writer)?,
173                 }
174                 Ok(())
175         }
176 }
177
178 #[cfg(anchors)]
179 /// The claim commonly referred to as the pre-signed second-stage HTLC transaction.
180 pub(crate) struct ExternalHTLCClaim {
181         pub(crate) commitment_txid: Txid,
182         pub(crate) per_commitment_number: u64,
183         pub(crate) htlc: HTLCOutputInCommitment,
184         pub(crate) preimage: Option<PaymentPreimage>,
185         pub(crate) counterparty_sig: Signature,
186 }
187
188 // Represents the different types of claims for which events are yielded externally to satisfy said
189 // claims.
190 #[cfg(anchors)]
191 pub(crate) enum ClaimEvent {
192         /// Event yielded to signal that the commitment transaction fee must be bumped to claim any
193         /// encumbered funds and proceed to HTLC resolution, if any HTLCs exist.
194         BumpCommitment {
195                 package_target_feerate_sat_per_1000_weight: u32,
196                 commitment_tx: Transaction,
197                 anchor_output_idx: u32,
198         },
199         /// Event yielded to signal that the commitment transaction has confirmed and its HTLCs must be
200         /// resolved by broadcasting a transaction with sufficient fee to claim them.
201         BumpHTLC {
202                 target_feerate_sat_per_1000_weight: u32,
203                 htlcs: Vec<ExternalHTLCClaim>,
204         },
205 }
206
207 /// Represents the different ways an output can be claimed (i.e., spent to an address under our
208 /// control) onchain.
209 pub(crate) enum OnchainClaim {
210         /// A finalized transaction pending confirmation spending the output to claim.
211         Tx(Transaction),
212         #[cfg(anchors)]
213         /// An event yielded externally to signal additional inputs must be added to a transaction
214         /// pending confirmation spending the output to claim.
215         Event(ClaimEvent),
216 }
217
218 /// An internal identifier to track pending package claims within the `OnchainTxHandler`.
219 type PackageID = [u8; 32];
220
221 /// OnchainTxHandler receives claiming requests, aggregates them if it's sound, broadcast and
222 /// do RBF bumping if possible.
223 pub struct OnchainTxHandler<ChannelSigner: WriteableEcdsaChannelSigner> {
224         destination_script: Script,
225         holder_commitment: HolderCommitmentTransaction,
226         // holder_htlc_sigs and prev_holder_htlc_sigs are in the order as they appear in the commitment
227         // transaction outputs (hence the Option<>s inside the Vec). The first usize is the index in
228         // the set of HTLCs in the HolderCommitmentTransaction.
229         holder_htlc_sigs: Option<Vec<Option<(usize, Signature)>>>,
230         prev_holder_commitment: Option<HolderCommitmentTransaction>,
231         prev_holder_htlc_sigs: Option<Vec<Option<(usize, Signature)>>>,
232
233         pub(super) signer: ChannelSigner,
234         pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
235
236         // Used to track claiming requests. If claim tx doesn't confirm before height timer expiration we need to bump
237         // it (RBF or CPFP). If an input has been part of an aggregate tx at first claim try, we need to keep it within
238         // another bumped aggregate tx to comply with RBF rules. We may have multiple claiming txn in the flight for the
239         // same set of outpoints. One of the outpoints may be spent by a transaction not issued by us. That's why at
240         // block connection we scan all inputs and if any of them is among a set of a claiming request we test for set
241         // equality between spending transaction and claim request. If true, it means transaction was one our claiming one
242         // after a security delay of 6 blocks we remove pending claim request. If false, it means transaction wasn't and
243         // we need to regenerate new claim request with reduced set of still-claimable outpoints.
244         // Key is identifier of the pending claim request, i.e the txid of the initial claiming transaction generated by
245         // us and is immutable until all outpoint of the claimable set are post-anti-reorg-delay solved.
246         // Entry is cache of elements need to generate a bumped claiming transaction (see ClaimTxBumpMaterial)
247         #[cfg(test)] // Used in functional_test to verify sanitization
248         pub(crate) pending_claim_requests: HashMap<PackageID, PackageTemplate>,
249         #[cfg(not(test))]
250         pending_claim_requests: HashMap<PackageID, PackageTemplate>,
251         #[cfg(anchors)]
252         pending_claim_events: HashMap<PackageID, ClaimEvent>,
253
254         // Used to link outpoints claimed in a connected block to a pending claim request. The keys
255         // represent the outpoints that our `ChannelMonitor` has detected we have keys/scripts to
256         // claim. The values track the pending claim request identifier and the initial confirmation
257         // block height, and are immutable until the outpoint has enough confirmations to meet our
258         // [`ANTI_REORG_DELAY`]. The initial confirmation block height is used to remove the entry if
259         // the block gets disconnected.
260         #[cfg(test)] // Used in functional_test to verify sanitization
261         pub claimable_outpoints: HashMap<BitcoinOutPoint, (PackageID, u32)>,
262         #[cfg(not(test))]
263         claimable_outpoints: HashMap<BitcoinOutPoint, (PackageID, u32)>,
264
265         locktimed_packages: BTreeMap<u32, Vec<PackageTemplate>>,
266
267         onchain_events_awaiting_threshold_conf: Vec<OnchainEventEntry>,
268
269         pub(super) secp_ctx: Secp256k1<secp256k1::All>,
270 }
271
272 impl<ChannelSigner: WriteableEcdsaChannelSigner> PartialEq for OnchainTxHandler<ChannelSigner> {
273         fn eq(&self, other: &Self) -> bool {
274                 // `signer`, `secp_ctx`, and `pending_claim_events` are excluded on purpose.
275                 self.destination_script == other.destination_script &&
276                         self.holder_commitment == other.holder_commitment &&
277                         self.holder_htlc_sigs == other.holder_htlc_sigs &&
278                         self.prev_holder_commitment == other.prev_holder_commitment &&
279                         self.prev_holder_htlc_sigs == other.prev_holder_htlc_sigs &&
280                         self.channel_transaction_parameters == other.channel_transaction_parameters &&
281                         self.pending_claim_requests == other.pending_claim_requests &&
282                         self.claimable_outpoints == other.claimable_outpoints &&
283                         self.locktimed_packages == other.locktimed_packages &&
284                         self.onchain_events_awaiting_threshold_conf == other.onchain_events_awaiting_threshold_conf
285         }
286 }
287
288 const SERIALIZATION_VERSION: u8 = 1;
289 const MIN_SERIALIZATION_VERSION: u8 = 1;
290
291 impl<ChannelSigner: WriteableEcdsaChannelSigner> OnchainTxHandler<ChannelSigner> {
292         pub(crate) fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
293                 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
294
295                 self.destination_script.write(writer)?;
296                 self.holder_commitment.write(writer)?;
297                 self.holder_htlc_sigs.write(writer)?;
298                 self.prev_holder_commitment.write(writer)?;
299                 self.prev_holder_htlc_sigs.write(writer)?;
300
301                 self.channel_transaction_parameters.write(writer)?;
302
303                 let mut key_data = VecWriter(Vec::new());
304                 self.signer.write(&mut key_data)?;
305                 assert!(key_data.0.len() < core::usize::MAX);
306                 assert!(key_data.0.len() < core::u32::MAX as usize);
307                 (key_data.0.len() as u32).write(writer)?;
308                 writer.write_all(&key_data.0[..])?;
309
310                 writer.write_all(&(self.pending_claim_requests.len() as u64).to_be_bytes())?;
311                 for (ref ancestor_claim_txid, request) in self.pending_claim_requests.iter() {
312                         ancestor_claim_txid.write(writer)?;
313                         request.write(writer)?;
314                 }
315
316                 writer.write_all(&(self.claimable_outpoints.len() as u64).to_be_bytes())?;
317                 for (ref outp, ref claim_and_height) in self.claimable_outpoints.iter() {
318                         outp.write(writer)?;
319                         claim_and_height.0.write(writer)?;
320                         claim_and_height.1.write(writer)?;
321                 }
322
323                 writer.write_all(&(self.locktimed_packages.len() as u64).to_be_bytes())?;
324                 for (ref locktime, ref packages) in self.locktimed_packages.iter() {
325                         locktime.write(writer)?;
326                         writer.write_all(&(packages.len() as u64).to_be_bytes())?;
327                         for ref package in packages.iter() {
328                                 package.write(writer)?;
329                         }
330                 }
331
332                 writer.write_all(&(self.onchain_events_awaiting_threshold_conf.len() as u64).to_be_bytes())?;
333                 for ref entry in self.onchain_events_awaiting_threshold_conf.iter() {
334                         entry.write(writer)?;
335                 }
336
337                 write_tlv_fields!(writer, {});
338                 Ok(())
339         }
340 }
341
342 impl<'a, 'b, ES: EntropySource, SP: SignerProvider> ReadableArgs<(&'a ES, &'b SP, u64, [u8; 32])> for OnchainTxHandler<SP::Signer> {
343         fn read<R: io::Read>(reader: &mut R, args: (&'a ES, &'b SP, u64, [u8; 32])) -> Result<Self, DecodeError> {
344                 let entropy_source = args.0;
345                 let signer_provider = args.1;
346                 let channel_value_satoshis = args.2;
347                 let channel_keys_id = args.3;
348
349                 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
350
351                 let destination_script = Readable::read(reader)?;
352
353                 let holder_commitment = Readable::read(reader)?;
354                 let holder_htlc_sigs = Readable::read(reader)?;
355                 let prev_holder_commitment = Readable::read(reader)?;
356                 let prev_holder_htlc_sigs = Readable::read(reader)?;
357
358                 let channel_parameters = Readable::read(reader)?;
359
360                 // Read the serialized signer bytes, but don't deserialize them, as we'll obtain our signer
361                 // by re-deriving the private key material.
362                 let keys_len: u32 = Readable::read(reader)?;
363                 let mut bytes_read = 0;
364                 while bytes_read != keys_len as usize {
365                         // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
366                         let mut data = [0; 1024];
367                         let bytes_to_read = cmp::min(1024, keys_len as usize - bytes_read);
368                         let read_slice = &mut data[0..bytes_to_read];
369                         reader.read_exact(read_slice)?;
370                         bytes_read += bytes_to_read;
371                 }
372
373                 let mut signer = signer_provider.derive_channel_signer(channel_value_satoshis, channel_keys_id);
374                 signer.provide_channel_parameters(&channel_parameters);
375
376                 let pending_claim_requests_len: u64 = Readable::read(reader)?;
377                 let mut pending_claim_requests = HashMap::with_capacity(cmp::min(pending_claim_requests_len as usize, MAX_ALLOC_SIZE / 128));
378                 for _ in 0..pending_claim_requests_len {
379                         pending_claim_requests.insert(Readable::read(reader)?, Readable::read(reader)?);
380                 }
381
382                 let claimable_outpoints_len: u64 = Readable::read(reader)?;
383                 let mut claimable_outpoints = HashMap::with_capacity(cmp::min(pending_claim_requests_len as usize, MAX_ALLOC_SIZE / 128));
384                 for _ in 0..claimable_outpoints_len {
385                         let outpoint = Readable::read(reader)?;
386                         let ancestor_claim_txid = Readable::read(reader)?;
387                         let height = Readable::read(reader)?;
388                         claimable_outpoints.insert(outpoint, (ancestor_claim_txid, height));
389                 }
390
391                 let locktimed_packages_len: u64 = Readable::read(reader)?;
392                 let mut locktimed_packages = BTreeMap::new();
393                 for _ in 0..locktimed_packages_len {
394                         let locktime = Readable::read(reader)?;
395                         let packages_len: u64 = Readable::read(reader)?;
396                         let mut packages = Vec::with_capacity(cmp::min(packages_len as usize, MAX_ALLOC_SIZE / core::mem::size_of::<PackageTemplate>()));
397                         for _ in 0..packages_len {
398                                 packages.push(Readable::read(reader)?);
399                         }
400                         locktimed_packages.insert(locktime, packages);
401                 }
402
403                 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
404                 let mut onchain_events_awaiting_threshold_conf = Vec::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
405                 for _ in 0..waiting_threshold_conf_len {
406                         if let Some(val) = MaybeReadable::read(reader)? {
407                                 onchain_events_awaiting_threshold_conf.push(val);
408                         }
409                 }
410
411                 read_tlv_fields!(reader, {});
412
413                 let mut secp_ctx = Secp256k1::new();
414                 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
415
416                 Ok(OnchainTxHandler {
417                         destination_script,
418                         holder_commitment,
419                         holder_htlc_sigs,
420                         prev_holder_commitment,
421                         prev_holder_htlc_sigs,
422                         signer,
423                         channel_transaction_parameters: channel_parameters,
424                         claimable_outpoints,
425                         locktimed_packages,
426                         pending_claim_requests,
427                         onchain_events_awaiting_threshold_conf,
428                         #[cfg(anchors)]
429                         pending_claim_events: HashMap::new(),
430                         secp_ctx,
431                 })
432         }
433 }
434
435 impl<ChannelSigner: WriteableEcdsaChannelSigner> OnchainTxHandler<ChannelSigner> {
436         pub(crate) fn new(destination_script: Script, signer: ChannelSigner, channel_parameters: ChannelTransactionParameters, holder_commitment: HolderCommitmentTransaction, secp_ctx: Secp256k1<secp256k1::All>) -> Self {
437                 OnchainTxHandler {
438                         destination_script,
439                         holder_commitment,
440                         holder_htlc_sigs: None,
441                         prev_holder_commitment: None,
442                         prev_holder_htlc_sigs: None,
443                         signer,
444                         channel_transaction_parameters: channel_parameters,
445                         pending_claim_requests: HashMap::new(),
446                         claimable_outpoints: HashMap::new(),
447                         locktimed_packages: BTreeMap::new(),
448                         onchain_events_awaiting_threshold_conf: Vec::new(),
449                         #[cfg(anchors)]
450                         pending_claim_events: HashMap::new(),
451
452                         secp_ctx,
453                 }
454         }
455
456         pub(crate) fn get_prev_holder_commitment_to_self_value(&self) -> Option<u64> {
457                 self.prev_holder_commitment.as_ref().map(|commitment| commitment.to_broadcaster_value_sat())
458         }
459
460         pub(crate) fn get_cur_holder_commitment_to_self_value(&self) -> u64 {
461                 self.holder_commitment.to_broadcaster_value_sat()
462         }
463
464         #[cfg(anchors)]
465         pub(crate) fn get_and_clear_pending_claim_events(&mut self) -> Vec<ClaimEvent> {
466                 let mut ret = HashMap::new();
467                 swap(&mut ret, &mut self.pending_claim_events);
468                 ret.into_iter().map(|(_, event)| event).collect::<Vec<_>>()
469         }
470
471         /// Lightning security model (i.e being able to redeem/timeout HTLC or penalize counterparty
472         /// onchain) lays on the assumption of claim transactions getting confirmed before timelock
473         /// expiration (CSV or CLTV following cases). In case of high-fee spikes, claim tx may get stuck
474         /// in the mempool, so you need to bump its feerate quickly using Replace-By-Fee or
475         /// Child-Pay-For-Parent.
476         ///
477         /// Panics if there are signing errors, because signing operations in reaction to on-chain
478         /// events are not expected to fail, and if they do, we may lose funds.
479         fn generate_claim<F: Deref, L: Deref>(&mut self, cur_height: u32, cached_request: &PackageTemplate, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L) -> Option<(Option<u32>, u64, OnchainClaim)>
480                 where F::Target: FeeEstimator,
481                                         L::Target: Logger,
482         {
483                 let request_outpoints = cached_request.outpoints();
484                 if request_outpoints.is_empty() {
485                         // Don't prune pending claiming request yet, we may have to resurrect HTLCs. Untractable
486                         // packages cannot be aggregated and will never be split, so we cannot end up with an
487                         // empty claim.
488                         debug_assert!(cached_request.is_malleable());
489                         return None;
490                 }
491                 // If we've seen transaction inclusion in the chain for all outpoints in our request, we
492                 // don't need to continue generating more claims. We'll keep tracking the request to fully
493                 // remove it once it reaches the confirmation threshold, or to generate a new claim if the
494                 // transaction is reorged out.
495                 let mut all_inputs_have_confirmed_spend = true;
496                 for outpoint in request_outpoints.iter() {
497                         if let Some((request_package_id, _)) = self.claimable_outpoints.get(*outpoint) {
498                                 // We check for outpoint spends within claims individually rather than as a set
499                                 // since requests can have outpoints split off.
500                                 if !self.onchain_events_awaiting_threshold_conf.iter()
501                                         .any(|event_entry| if let OnchainEvent::Claim { package_id } = event_entry.event {
502                                                 *request_package_id == package_id
503                                         } else {
504                                                 // The onchain event is not a claim, keep seeking until we find one.
505                                                 false
506                                         })
507                                 {
508                                         // Either we had no `OnchainEvent::Claim`, or we did but none matched the
509                                         // outpoint's registered spend.
510                                         all_inputs_have_confirmed_spend = false;
511                                 }
512                         } else {
513                                 // The request's outpoint spend does not exist yet.
514                                 all_inputs_have_confirmed_spend = false;
515                         }
516                 }
517                 if all_inputs_have_confirmed_spend {
518                         return None;
519                 }
520
521                 // Compute new height timer to decide when we need to regenerate a new bumped version of the claim tx (if we
522                 // didn't receive confirmation of it before, or not enough reorg-safe depth on top of it).
523                 let new_timer = Some(cached_request.get_height_timer(cur_height));
524                 if cached_request.is_malleable() {
525                         #[cfg(anchors)]
526                         { // Attributes are not allowed on if expressions on our current MSRV of 1.41.
527                                 if cached_request.requires_external_funding() {
528                                         let target_feerate_sat_per_1000_weight = cached_request
529                                                 .compute_package_feerate(fee_estimator, ConfirmationTarget::HighPriority);
530                                         if let Some(htlcs) = cached_request.construct_malleable_package_with_external_funding(self) {
531                                                 return Some((
532                                                         new_timer,
533                                                         target_feerate_sat_per_1000_weight as u64,
534                                                         OnchainClaim::Event(ClaimEvent::BumpHTLC {
535                                                                 target_feerate_sat_per_1000_weight,
536                                                                 htlcs,
537                                                         }),
538                                                 ));
539                                         } else {
540                                                 return None;
541                                         }
542                                 }
543                         }
544
545                         let predicted_weight = cached_request.package_weight(&self.destination_script);
546                         if let Some((output_value, new_feerate)) = cached_request.compute_package_output(
547                                 predicted_weight, self.destination_script.dust_value().to_sat(), fee_estimator, logger,
548                         ) {
549                                 assert!(new_feerate != 0);
550
551                                 let transaction = cached_request.finalize_malleable_package(self, output_value, self.destination_script.clone(), logger).unwrap();
552                                 log_trace!(logger, "...with timer {} and feerate {}", new_timer.unwrap(), new_feerate);
553                                 assert!(predicted_weight >= transaction.weight());
554                                 return Some((new_timer, new_feerate, OnchainClaim::Tx(transaction)));
555                         }
556                 } else {
557                         // Untractable packages cannot have their fees bumped through Replace-By-Fee. Some
558                         // packages may support fee bumping through Child-Pays-For-Parent, indicated by those
559                         // which require external funding.
560                         #[cfg(not(anchors))]
561                         let inputs = cached_request.inputs();
562                         #[cfg(anchors)]
563                         let mut inputs = cached_request.inputs();
564                         debug_assert_eq!(inputs.len(), 1);
565                         let tx = match cached_request.finalize_untractable_package(self, logger) {
566                                 Some(tx) => tx,
567                                 None => return None,
568                         };
569                         if !cached_request.requires_external_funding() {
570                                 return Some((None, 0, OnchainClaim::Tx(tx)));
571                         }
572                         #[cfg(anchors)]
573                         return inputs.find_map(|input| match input {
574                                 // Commitment inputs with anchors support are the only untractable inputs supported
575                                 // thus far that require external funding.
576                                 PackageSolvingData::HolderFundingOutput(..) => {
577                                         debug_assert_eq!(tx.txid(), self.holder_commitment.trust().txid(),
578                                                 "Holder commitment transaction mismatch");
579                                         // We'll locate an anchor output we can spend within the commitment transaction.
580                                         let funding_pubkey = &self.channel_transaction_parameters.holder_pubkeys.funding_pubkey;
581                                         match chan_utils::get_anchor_output(&tx, funding_pubkey) {
582                                                 // An anchor output was found, so we should yield a funding event externally.
583                                                 Some((idx, _)) => {
584                                                         // TODO: Use a lower confirmation target when both our and the
585                                                         // counterparty's latest commitment don't have any HTLCs present.
586                                                         let conf_target = ConfirmationTarget::HighPriority;
587                                                         let package_target_feerate_sat_per_1000_weight = cached_request
588                                                                 .compute_package_feerate(fee_estimator, conf_target);
589                                                         Some((
590                                                                 new_timer,
591                                                                 package_target_feerate_sat_per_1000_weight as u64,
592                                                                 OnchainClaim::Event(ClaimEvent::BumpCommitment {
593                                                                         package_target_feerate_sat_per_1000_weight,
594                                                                         commitment_tx: tx.clone(),
595                                                                         anchor_output_idx: idx,
596                                                                 }),
597                                                         ))
598                                                 },
599                                                 // An anchor output was not found. There's nothing we can do other than
600                                                 // attempt to broadcast the transaction with its current fee rate and hope
601                                                 // it confirms. This is essentially the same behavior as a commitment
602                                                 // transaction without anchor outputs.
603                                                 None => Some((None, 0, OnchainClaim::Tx(tx.clone()))),
604                                         }
605                                 },
606                                 _ => {
607                                         debug_assert!(false, "Only HolderFundingOutput inputs should be untractable and require external funding");
608                                         None
609                                 },
610                         })
611                 }
612                 None
613         }
614
615         /// Upon channelmonitor.block_connected(..) or upon provision of a preimage on the forward link
616         /// for this channel, provide new relevant on-chain transactions and/or new claim requests.
617         /// Together with `update_claims_view_from_matched_txn` this used to be named
618         /// `block_connected`, but it is now also used for claiming an HTLC output if we receive a
619         /// preimage after force-close.
620         ///
621         /// `conf_height` represents the height at which the request was generated. This
622         /// does not need to equal the current blockchain tip height, which should be provided via
623         /// `cur_height`, however it must never be higher than `cur_height`.
624         pub(crate) fn update_claims_view_from_requests<B: Deref, F: Deref, L: Deref>(
625                 &mut self, requests: Vec<PackageTemplate>, conf_height: u32, cur_height: u32,
626                 broadcaster: &B, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L
627         ) where
628                 B::Target: BroadcasterInterface,
629                 F::Target: FeeEstimator,
630                 L::Target: Logger,
631         {
632                 log_debug!(logger, "Updating claims view at height {} with {} claim requests", cur_height, requests.len());
633                 let mut preprocessed_requests = Vec::with_capacity(requests.len());
634                 let mut aggregated_request = None;
635
636                 // Try to aggregate outputs if their timelock expiration isn't imminent (package timelock
637                 // <= CLTV_SHARED_CLAIM_BUFFER) and they don't require an immediate nLockTime (aggregable).
638                 for req in requests {
639                         // Don't claim a outpoint twice that would be bad for privacy and may uselessly lock a CPFP input for a while
640                         if let Some(_) = self.claimable_outpoints.get(req.outpoints()[0]) {
641                                 log_info!(logger, "Ignoring second claim for outpoint {}:{}, already registered its claiming request", req.outpoints()[0].txid, req.outpoints()[0].vout);
642                         } else {
643                                 let timelocked_equivalent_package = self.locktimed_packages.iter().map(|v| v.1.iter()).flatten()
644                                         .find(|locked_package| locked_package.outpoints() == req.outpoints());
645                                 if let Some(package) = timelocked_equivalent_package {
646                                         log_info!(logger, "Ignoring second claim for outpoint {}:{}, we already have one which we're waiting on a timelock at {} for.",
647                                                 req.outpoints()[0].txid, req.outpoints()[0].vout, package.package_timelock());
648                                         continue;
649                                 }
650
651                                 if req.package_timelock() > cur_height + 1 {
652                                         log_info!(logger, "Delaying claim of package until its timelock at {} (current height {}), the following outpoints are spent:", req.package_timelock(), cur_height);
653                                         for outpoint in req.outpoints() {
654                                                 log_info!(logger, "  Outpoint {}", outpoint);
655                                         }
656                                         self.locktimed_packages.entry(req.package_timelock()).or_insert(Vec::new()).push(req);
657                                         continue;
658                                 }
659
660                                 log_trace!(logger, "Test if outpoint can be aggregated with expiration {} against {}", req.timelock(), cur_height + CLTV_SHARED_CLAIM_BUFFER);
661                                 if req.timelock() <= cur_height + CLTV_SHARED_CLAIM_BUFFER || !req.aggregable() {
662                                         // Don't aggregate if outpoint package timelock is soon or marked as non-aggregable
663                                         preprocessed_requests.push(req);
664                                 } else if aggregated_request.is_none() {
665                                         aggregated_request = Some(req);
666                                 } else {
667                                         aggregated_request.as_mut().unwrap().merge_package(req);
668                                 }
669                         }
670                 }
671                 if let Some(req) = aggregated_request {
672                         preprocessed_requests.push(req);
673                 }
674
675                 // Claim everything up to and including cur_height + 1
676                 let remaining_locked_packages = self.locktimed_packages.split_off(&(cur_height + 2));
677                 for (pop_height, mut entry) in self.locktimed_packages.iter_mut() {
678                         log_trace!(logger, "Restoring delayed claim of package(s) at their timelock at {}.", pop_height);
679                         preprocessed_requests.append(&mut entry);
680                 }
681                 self.locktimed_packages = remaining_locked_packages;
682
683                 // Generate claim transactions and track them to bump if necessary at
684                 // height timer expiration (i.e in how many blocks we're going to take action).
685                 for mut req in preprocessed_requests {
686                         if let Some((new_timer, new_feerate, claim)) = self.generate_claim(cur_height, &req, &*fee_estimator, &*logger) {
687                                 req.set_timer(new_timer);
688                                 req.set_feerate(new_feerate);
689                                 let package_id = match claim {
690                                         OnchainClaim::Tx(tx) => {
691                                                 log_info!(logger, "Broadcasting onchain {}", log_tx!(tx));
692                                                 broadcaster.broadcast_transaction(&tx);
693                                                 tx.txid().into_inner()
694                                         },
695                                         #[cfg(anchors)]
696                                         OnchainClaim::Event(claim_event) => {
697                                                 log_info!(logger, "Yielding onchain event to spend inputs {:?}", req.outpoints());
698                                                 let package_id = match claim_event {
699                                                         ClaimEvent::BumpCommitment { ref commitment_tx, .. } => commitment_tx.txid().into_inner(),
700                                                         ClaimEvent::BumpHTLC { ref htlcs, .. } => {
701                                                                 // Use the same construction as a lightning channel id to generate
702                                                                 // the package id for this request based on the first HTLC. It
703                                                                 // doesn't matter what we use as long as it's unique per request.
704                                                                 let mut package_id = [0; 32];
705                                                                 package_id[..].copy_from_slice(&htlcs[0].commitment_txid[..]);
706                                                                 let htlc_output_index = htlcs[0].htlc.transaction_output_index.unwrap();
707                                                                 package_id[30] ^= ((htlc_output_index >> 8) & 0xff) as u8;
708                                                                 package_id[31] ^= ((htlc_output_index >> 0) & 0xff) as u8;
709                                                                 package_id
710                                                         },
711                                                 };
712                                                 self.pending_claim_events.insert(package_id, claim_event);
713                                                 package_id
714                                         },
715                                 };
716                                 for k in req.outpoints() {
717                                         log_info!(logger, "Registering claiming request for {}:{}", k.txid, k.vout);
718                                         self.claimable_outpoints.insert(k.clone(), (package_id, conf_height));
719                                 }
720                                 self.pending_claim_requests.insert(package_id, req);
721                         }
722                 }
723         }
724
725         /// Upon channelmonitor.block_connected(..) or upon provision of a preimage on the forward link
726         /// for this channel, provide new relevant on-chain transactions and/or new claim requests.
727         /// Together with `update_claims_view_from_requests` this used to be named `block_connected`,
728         /// but it is now also used for claiming an HTLC output if we receive a preimage after force-close.
729         ///
730         /// `conf_height` represents the height at which the transactions in `txn_matched` were
731         /// confirmed. This does not need to equal the current blockchain tip height, which should be
732         /// provided via `cur_height`, however it must never be higher than `cur_height`.
733         pub(crate) fn update_claims_view_from_matched_txn<B: Deref, F: Deref, L: Deref>(
734                 &mut self, txn_matched: &[&Transaction], conf_height: u32, conf_hash: BlockHash,
735                 cur_height: u32, broadcaster: &B, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L
736         ) where
737                 B::Target: BroadcasterInterface,
738                 F::Target: FeeEstimator,
739                 L::Target: Logger,
740         {
741                 log_debug!(logger, "Updating claims view at height {} with {} matched transactions in block {}", cur_height, txn_matched.len(), conf_height);
742                 let mut bump_candidates = HashMap::new();
743                 for tx in txn_matched {
744                         // Scan all input to verify is one of the outpoint spent is of interest for us
745                         let mut claimed_outputs_material = Vec::new();
746                         for inp in &tx.input {
747                                 if let Some((package_id, _)) = self.claimable_outpoints.get(&inp.previous_output) {
748                                         // If outpoint has claim request pending on it...
749                                         if let Some(request) = self.pending_claim_requests.get_mut(package_id) {
750                                                 //... we need to verify equality between transaction outpoints and claim request
751                                                 // outpoints to know if transaction is the original claim or a bumped one issued
752                                                 // by us.
753                                                 let mut are_sets_equal = true;
754                                                 let mut tx_inputs = tx.input.iter().map(|input| &input.previous_output).collect::<Vec<_>>();
755                                                 tx_inputs.sort_unstable();
756                                                 for request_input in request.outpoints() {
757                                                         if tx_inputs.binary_search(&request_input).is_err() {
758                                                                 are_sets_equal = false;
759                                                                 break;
760                                                         }
761                                                 }
762
763                                                 macro_rules! clean_claim_request_after_safety_delay {
764                                                         () => {
765                                                                 let entry = OnchainEventEntry {
766                                                                         txid: tx.txid(),
767                                                                         height: conf_height,
768                                                                         block_hash: Some(conf_hash),
769                                                                         event: OnchainEvent::Claim { package_id: *package_id }
770                                                                 };
771                                                                 if !self.onchain_events_awaiting_threshold_conf.contains(&entry) {
772                                                                         self.onchain_events_awaiting_threshold_conf.push(entry);
773                                                                 }
774                                                         }
775                                                 }
776
777                                                 // If this is our transaction (or our counterparty spent all the outputs
778                                                 // before we could anyway with same inputs order than us), wait for
779                                                 // ANTI_REORG_DELAY and clean the RBF tracking map.
780                                                 if are_sets_equal {
781                                                         clean_claim_request_after_safety_delay!();
782                                                 } else { // If false, generate new claim request with update outpoint set
783                                                         let mut at_least_one_drop = false;
784                                                         for input in tx.input.iter() {
785                                                                 if let Some(package) = request.split_package(&input.previous_output) {
786                                                                         claimed_outputs_material.push(package);
787                                                                         at_least_one_drop = true;
788                                                                 }
789                                                                 // If there are no outpoints left to claim in this request, drop it entirely after ANTI_REORG_DELAY.
790                                                                 if request.outpoints().is_empty() {
791                                                                         clean_claim_request_after_safety_delay!();
792                                                                 }
793                                                         }
794                                                         //TODO: recompute soonest_timelock to avoid wasting a bit on fees
795                                                         if at_least_one_drop {
796                                                                 bump_candidates.insert(*package_id, request.clone());
797                                                         }
798                                                 }
799                                                 break; //No need to iterate further, either tx is our or their
800                                         } else {
801                                                 panic!("Inconsistencies between pending_claim_requests map and claimable_outpoints map");
802                                         }
803                                 }
804                         }
805                         for package in claimed_outputs_material.drain(..) {
806                                 let entry = OnchainEventEntry {
807                                         txid: tx.txid(),
808                                         height: conf_height,
809                                         block_hash: Some(conf_hash),
810                                         event: OnchainEvent::ContentiousOutpoint { package },
811                                 };
812                                 if !self.onchain_events_awaiting_threshold_conf.contains(&entry) {
813                                         self.onchain_events_awaiting_threshold_conf.push(entry);
814                                 }
815                         }
816                 }
817
818                 // After security delay, either our claim tx got enough confs or outpoint is definetely out of reach
819                 let onchain_events_awaiting_threshold_conf =
820                         self.onchain_events_awaiting_threshold_conf.drain(..).collect::<Vec<_>>();
821                 for entry in onchain_events_awaiting_threshold_conf {
822                         if entry.has_reached_confirmation_threshold(cur_height) {
823                                 match entry.event {
824                                         OnchainEvent::Claim { package_id } => {
825                                                 // We may remove a whole set of claim outpoints here, as these one may have
826                                                 // been aggregated in a single tx and claimed so atomically
827                                                 if let Some(request) = self.pending_claim_requests.remove(&package_id) {
828                                                         for outpoint in request.outpoints() {
829                                                                 log_debug!(logger, "Removing claim tracking for {} due to maturation of claim package {}.",
830                                                                         outpoint, log_bytes!(package_id));
831                                                                 self.claimable_outpoints.remove(outpoint);
832                                                                 #[cfg(anchors)]
833                                                                 self.pending_claim_events.remove(&package_id);
834                                                         }
835                                                 }
836                                         },
837                                         OnchainEvent::ContentiousOutpoint { package } => {
838                                                 log_debug!(logger, "Removing claim tracking due to maturation of claim tx for outpoints:");
839                                                 log_debug!(logger, " {:?}", package.outpoints());
840                                                 self.claimable_outpoints.remove(package.outpoints()[0]);
841                                         }
842                                 }
843                         } else {
844                                 self.onchain_events_awaiting_threshold_conf.push(entry);
845                         }
846                 }
847
848                 // Check if any pending claim request must be rescheduled
849                 for (package_id, request) in self.pending_claim_requests.iter() {
850                         if let Some(h) = request.timer() {
851                                 if cur_height >= h {
852                                         bump_candidates.insert(*package_id, request.clone());
853                                 }
854                         }
855                 }
856
857                 // Build, bump and rebroadcast tx accordingly
858                 log_trace!(logger, "Bumping {} candidates", bump_candidates.len());
859                 for (package_id, request) in bump_candidates.iter() {
860                         if let Some((new_timer, new_feerate, bump_claim)) = self.generate_claim(cur_height, &request, &*fee_estimator, &*logger) {
861                                 match bump_claim {
862                                         OnchainClaim::Tx(bump_tx) => {
863                                                 log_info!(logger, "Broadcasting RBF-bumped onchain {}", log_tx!(bump_tx));
864                                                 broadcaster.broadcast_transaction(&bump_tx);
865                                         },
866                                         #[cfg(anchors)]
867                                         OnchainClaim::Event(claim_event) => {
868                                                 log_info!(logger, "Yielding RBF-bumped onchain event to spend inputs {:?}", request.outpoints());
869                                                 self.pending_claim_events.insert(*package_id, claim_event);
870                                         },
871                                 }
872                                 if let Some(request) = self.pending_claim_requests.get_mut(package_id) {
873                                         request.set_timer(new_timer);
874                                         request.set_feerate(new_feerate);
875                                 }
876                         }
877                 }
878         }
879
880         pub(crate) fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
881                 &mut self,
882                 txid: &Txid,
883                 broadcaster: B,
884                 fee_estimator: &LowerBoundedFeeEstimator<F>,
885                 logger: L,
886         ) where
887                 B::Target: BroadcasterInterface,
888                 F::Target: FeeEstimator,
889                 L::Target: Logger,
890         {
891                 let mut height = None;
892                 for entry in self.onchain_events_awaiting_threshold_conf.iter() {
893                         if entry.txid == *txid {
894                                 height = Some(entry.height);
895                                 break;
896                         }
897                 }
898
899                 if let Some(height) = height {
900                         self.block_disconnected(height, broadcaster, fee_estimator, logger);
901                 }
902         }
903
904         pub(crate) fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, height: u32, broadcaster: B, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: L)
905                 where B::Target: BroadcasterInterface,
906                       F::Target: FeeEstimator,
907                                         L::Target: Logger,
908         {
909                 let mut bump_candidates = HashMap::new();
910                 let onchain_events_awaiting_threshold_conf =
911                         self.onchain_events_awaiting_threshold_conf.drain(..).collect::<Vec<_>>();
912                 for entry in onchain_events_awaiting_threshold_conf {
913                         if entry.height >= height {
914                                 //- our claim tx on a commitment tx output
915                                 //- resurect outpoint back in its claimable set and regenerate tx
916                                 match entry.event {
917                                         OnchainEvent::ContentiousOutpoint { package } => {
918                                                 if let Some(pending_claim) = self.claimable_outpoints.get(package.outpoints()[0]) {
919                                                         if let Some(request) = self.pending_claim_requests.get_mut(&pending_claim.0) {
920                                                                 request.merge_package(package);
921                                                                 // Using a HashMap guarantee us than if we have multiple outpoints getting
922                                                                 // resurrected only one bump claim tx is going to be broadcast
923                                                                 bump_candidates.insert(pending_claim.clone(), request.clone());
924                                                         }
925                                                 }
926                                         },
927                                         _ => {},
928                                 }
929                         } else {
930                                 self.onchain_events_awaiting_threshold_conf.push(entry);
931                         }
932                 }
933                 for ((_package_id, _), request) in bump_candidates.iter_mut() {
934                         if let Some((new_timer, new_feerate, bump_claim)) = self.generate_claim(height, &request, fee_estimator, &&*logger) {
935                                 request.set_timer(new_timer);
936                                 request.set_feerate(new_feerate);
937                                 match bump_claim {
938                                         OnchainClaim::Tx(bump_tx) => {
939                                                 log_info!(logger, "Broadcasting onchain {}", log_tx!(bump_tx));
940                                                 broadcaster.broadcast_transaction(&bump_tx);
941                                         },
942                                         #[cfg(anchors)]
943                                         OnchainClaim::Event(claim_event) => {
944                                                 log_info!(logger, "Yielding onchain event after reorg to spend inputs {:?}", request.outpoints());
945                                                 self.pending_claim_events.insert(_package_id, claim_event);
946                                         },
947                                 }
948                         }
949                 }
950                 for (ancestor_claim_txid, request) in bump_candidates.drain() {
951                         self.pending_claim_requests.insert(ancestor_claim_txid.0, request);
952                 }
953                 //TODO: if we implement cross-block aggregated claim transaction we need to refresh set of outpoints and regenerate tx but
954                 // right now if one of the outpoint get disconnected, just erase whole pending claim request.
955                 let mut remove_request = Vec::new();
956                 self.claimable_outpoints.retain(|_, ref v|
957                         if v.1 >= height {
958                         remove_request.push(v.0.clone());
959                         false
960                         } else { true });
961                 for req in remove_request {
962                         self.pending_claim_requests.remove(&req);
963                 }
964         }
965
966         pub(crate) fn is_output_spend_pending(&self, outpoint: &BitcoinOutPoint) -> bool {
967                 self.claimable_outpoints.get(outpoint).is_some()
968         }
969
970         pub(crate) fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
971                 let mut txids: Vec<(Txid, Option<BlockHash>)> = self.onchain_events_awaiting_threshold_conf
972                         .iter()
973                         .map(|entry| (entry.txid, entry.block_hash))
974                         .collect();
975                 txids.sort_unstable_by_key(|(txid, _)| *txid);
976                 txids.dedup();
977                 txids
978         }
979
980         pub(crate) fn provide_latest_holder_tx(&mut self, tx: HolderCommitmentTransaction) {
981                 self.prev_holder_commitment = Some(replace(&mut self.holder_commitment, tx));
982                 self.holder_htlc_sigs = None;
983         }
984
985         // Normally holder HTLCs are signed at the same time as the holder commitment tx.  However,
986         // in some configurations, the holder commitment tx has been signed and broadcast by a
987         // ChannelMonitor replica, so we handle that case here.
988         fn sign_latest_holder_htlcs(&mut self) {
989                 if self.holder_htlc_sigs.is_none() {
990                         let (_sig, sigs) = self.signer.sign_holder_commitment_and_htlcs(&self.holder_commitment, &self.secp_ctx).expect("sign holder commitment");
991                         self.holder_htlc_sigs = Some(Self::extract_holder_sigs(&self.holder_commitment, sigs));
992                 }
993         }
994
995         // Normally only the latest commitment tx and HTLCs need to be signed.  However, in some
996         // configurations we may have updated our holder commitment but a replica of the ChannelMonitor
997         // broadcast the previous one before we sync with it.  We handle that case here.
998         fn sign_prev_holder_htlcs(&mut self) {
999                 if self.prev_holder_htlc_sigs.is_none() {
1000                         if let Some(ref holder_commitment) = self.prev_holder_commitment {
1001                                 let (_sig, sigs) = self.signer.sign_holder_commitment_and_htlcs(holder_commitment, &self.secp_ctx).expect("sign previous holder commitment");
1002                                 self.prev_holder_htlc_sigs = Some(Self::extract_holder_sigs(holder_commitment, sigs));
1003                         }
1004                 }
1005         }
1006
1007         fn extract_holder_sigs(holder_commitment: &HolderCommitmentTransaction, sigs: Vec<Signature>) -> Vec<Option<(usize, Signature)>> {
1008                 let mut ret = Vec::new();
1009                 for (htlc_idx, (holder_sig, htlc)) in sigs.iter().zip(holder_commitment.htlcs().iter()).enumerate() {
1010                         let tx_idx = htlc.transaction_output_index.unwrap();
1011                         if ret.len() <= tx_idx as usize { ret.resize(tx_idx as usize + 1, None); }
1012                         ret[tx_idx as usize] = Some((htlc_idx, holder_sig.clone()));
1013                 }
1014                 ret
1015         }
1016
1017         //TODO: getting lastest holder transactions should be infallible and result in us "force-closing the channel", but we may
1018         // have empty holder commitment transaction if a ChannelMonitor is asked to force-close just after Channel::get_outbound_funding_created,
1019         // before providing a initial commitment transaction. For outbound channel, init ChannelMonitor at Channel::funding_signed, there is nothing
1020         // to monitor before.
1021         pub(crate) fn get_fully_signed_holder_tx(&mut self, funding_redeemscript: &Script) -> Transaction {
1022                 let (sig, htlc_sigs) = self.signer.sign_holder_commitment_and_htlcs(&self.holder_commitment, &self.secp_ctx).expect("signing holder commitment");
1023                 self.holder_htlc_sigs = Some(Self::extract_holder_sigs(&self.holder_commitment, htlc_sigs));
1024                 self.holder_commitment.add_holder_sig(funding_redeemscript, sig)
1025         }
1026
1027         #[cfg(any(test, feature="unsafe_revoked_tx_signing"))]
1028         pub(crate) fn get_fully_signed_copy_holder_tx(&mut self, funding_redeemscript: &Script) -> Transaction {
1029                 let (sig, htlc_sigs) = self.signer.unsafe_sign_holder_commitment_and_htlcs(&self.holder_commitment, &self.secp_ctx).expect("sign holder commitment");
1030                 self.holder_htlc_sigs = Some(Self::extract_holder_sigs(&self.holder_commitment, htlc_sigs));
1031                 self.holder_commitment.add_holder_sig(funding_redeemscript, sig)
1032         }
1033
1034         pub(crate) fn get_fully_signed_htlc_tx(&mut self, outp: &::bitcoin::OutPoint, preimage: &Option<PaymentPreimage>) -> Option<Transaction> {
1035                 let mut htlc_tx = None;
1036                 let commitment_txid = self.holder_commitment.trust().txid();
1037                 // Check if the HTLC spends from the current holder commitment
1038                 if commitment_txid == outp.txid {
1039                         self.sign_latest_holder_htlcs();
1040                         if let &Some(ref htlc_sigs) = &self.holder_htlc_sigs {
1041                                 let &(ref htlc_idx, ref htlc_sig) = htlc_sigs[outp.vout as usize].as_ref().unwrap();
1042                                 let trusted_tx = self.holder_commitment.trust();
1043                                 let counterparty_htlc_sig = self.holder_commitment.counterparty_htlc_sigs[*htlc_idx];
1044                                 htlc_tx = Some(trusted_tx
1045                                         .get_signed_htlc_tx(&self.channel_transaction_parameters.as_holder_broadcastable(), *htlc_idx, &counterparty_htlc_sig, htlc_sig, preimage));
1046                         }
1047                 }
1048                 // If the HTLC doesn't spend the current holder commitment, check if it spends the previous one
1049                 if htlc_tx.is_none() && self.prev_holder_commitment.is_some() {
1050                         let commitment_txid = self.prev_holder_commitment.as_ref().unwrap().trust().txid();
1051                         if commitment_txid == outp.txid {
1052                                 self.sign_prev_holder_htlcs();
1053                                 if let &Some(ref htlc_sigs) = &self.prev_holder_htlc_sigs {
1054                                         let &(ref htlc_idx, ref htlc_sig) = htlc_sigs[outp.vout as usize].as_ref().unwrap();
1055                                         let holder_commitment = self.prev_holder_commitment.as_ref().unwrap();
1056                                         let trusted_tx = holder_commitment.trust();
1057                                         let counterparty_htlc_sig = holder_commitment.counterparty_htlc_sigs[*htlc_idx];
1058                                         htlc_tx = Some(trusted_tx
1059                                                 .get_signed_htlc_tx(&self.channel_transaction_parameters.as_holder_broadcastable(), *htlc_idx, &counterparty_htlc_sig, htlc_sig, preimage));
1060                                 }
1061                         }
1062                 }
1063                 htlc_tx
1064         }
1065
1066         #[cfg(anchors)]
1067         pub(crate) fn generate_external_htlc_claim(
1068                 &self, outp: &::bitcoin::OutPoint, preimage: &Option<PaymentPreimage>
1069         ) -> Option<ExternalHTLCClaim> {
1070                 let find_htlc = |holder_commitment: &HolderCommitmentTransaction| -> Option<ExternalHTLCClaim> {
1071                         let trusted_tx = holder_commitment.trust();
1072                         if outp.txid != trusted_tx.txid() {
1073                                 return None;
1074                         }
1075                         trusted_tx.htlcs().iter().enumerate()
1076                                 .find(|(_, htlc)| if let Some(output_index) = htlc.transaction_output_index {
1077                                         output_index == outp.vout
1078                                 } else {
1079                                         false
1080                                 })
1081                                 .map(|(htlc_idx, htlc)| {
1082                                         let counterparty_htlc_sig = holder_commitment.counterparty_htlc_sigs[htlc_idx];
1083                                         ExternalHTLCClaim {
1084                                                 commitment_txid: trusted_tx.txid(),
1085                                                 per_commitment_number: trusted_tx.commitment_number(),
1086                                                 htlc: htlc.clone(),
1087                                                 preimage: *preimage,
1088                                                 counterparty_sig: counterparty_htlc_sig,
1089                                         }
1090                                 })
1091                 };
1092                 // Check if the HTLC spends from the current holder commitment or the previous one otherwise.
1093                 find_htlc(&self.holder_commitment)
1094                         .or_else(|| self.prev_holder_commitment.as_ref().map(|c| find_htlc(c)).flatten())
1095         }
1096
1097         pub(crate) fn opt_anchors(&self) -> bool {
1098                 self.channel_transaction_parameters.opt_anchors.is_some()
1099         }
1100
1101         #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
1102         pub(crate) fn unsafe_get_fully_signed_htlc_tx(&mut self, outp: &::bitcoin::OutPoint, preimage: &Option<PaymentPreimage>) -> Option<Transaction> {
1103                 let latest_had_sigs = self.holder_htlc_sigs.is_some();
1104                 let prev_had_sigs = self.prev_holder_htlc_sigs.is_some();
1105                 let ret = self.get_fully_signed_htlc_tx(outp, preimage);
1106                 if !latest_had_sigs {
1107                         self.holder_htlc_sigs = None;
1108                 }
1109                 if !prev_had_sigs {
1110                         self.prev_holder_htlc_sigs = None;
1111                 }
1112                 ret
1113         }
1114 }