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