Move HTLCDescriptor to sign module
[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::PackedLockTime;
16 use bitcoin::blockdata::transaction::Transaction;
17 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
18 use bitcoin::blockdata::script::Script;
19 use bitcoin::hashes::{Hash, HashEngine};
20 use bitcoin::hashes::sha256::Hash as Sha256;
21 use bitcoin::hash_types::{Txid, BlockHash};
22 use bitcoin::secp256k1::{Secp256k1, ecdsa::Signature};
23 use bitcoin::secp256k1;
24
25 use crate::chain::chaininterface::compute_feerate_sat_per_1000_weight;
26 use crate::sign::{ChannelDerivationParameters, HTLCDescriptor, ChannelSigner, EntropySource, SignerProvider, WriteableEcdsaChannelSigner};
27 use crate::ln::msgs::DecodeError;
28 use crate::ln::PaymentPreimage;
29 use crate::ln::chan_utils::{self, ChannelTransactionParameters, HTLCOutputInCommitment, HolderCommitmentTransaction};
30 use crate::chain::ClaimId;
31 use crate::chain::chaininterface::{ConfirmationTarget, FeeEstimator, BroadcasterInterface, LowerBoundedFeeEstimator};
32 use crate::chain::channelmonitor::{ANTI_REORG_DELAY, CLTV_SHARED_CLAIM_BUFFER};
33 use crate::chain::package::{PackageSolvingData, PackageTemplate};
34 use crate::util::logger::Logger;
35 use crate::util::ser::{Readable, ReadableArgs, MaybeReadable, UpgradableRequired, Writer, Writeable, VecWriter};
36
37 use crate::io;
38 use crate::prelude::*;
39 use alloc::collections::BTreeMap;
40 use core::cmp;
41 use core::ops::Deref;
42 use core::mem::replace;
43 use core::mem::swap;
44 use crate::ln::features::ChannelTypeFeatures;
45
46 const MAX_ALLOC_SIZE: usize = 64*1024;
47
48 /// An entry for an [`OnchainEvent`], stating the block height when the event was observed and the
49 /// transaction causing it.
50 ///
51 /// Used to determine when the on-chain event can be considered safe from a chain reorganization.
52 #[derive(Clone, PartialEq, Eq)]
53 struct OnchainEventEntry {
54         txid: Txid,
55         height: u32,
56         block_hash: Option<BlockHash>, // Added as optional, will be filled in for any entry generated on 0.0.113 or after
57         event: OnchainEvent,
58 }
59
60 impl OnchainEventEntry {
61         fn confirmation_threshold(&self) -> u32 {
62                 self.height + ANTI_REORG_DELAY - 1
63         }
64
65         fn has_reached_confirmation_threshold(&self, height: u32) -> bool {
66                 height >= self.confirmation_threshold()
67         }
68 }
69
70 /// Events for claims the [`OnchainTxHandler`] has generated. Once the events are considered safe
71 /// from a chain reorg, the [`OnchainTxHandler`] will act accordingly.
72 #[derive(Clone, PartialEq, Eq)]
73 enum OnchainEvent {
74         /// A pending request has been claimed by a transaction spending the exact same set of outpoints
75         /// as the request. This claim can either be ours or from the counterparty. Once the claiming
76         /// transaction has met [`ANTI_REORG_DELAY`] confirmations, we consider it final and remove the
77         /// pending request.
78         Claim {
79                 claim_id: ClaimId,
80         },
81         /// The counterparty has claimed an outpoint from one of our pending requests through a
82         /// different transaction than ours. If our transaction was attempting to claim multiple
83         /// outputs, we need to drop the outpoint claimed by the counterparty and regenerate a new claim
84         /// transaction for ourselves. We keep tracking, separately, the outpoint claimed by the
85         /// counterparty up to [`ANTI_REORG_DELAY`] confirmations to ensure we attempt to re-claim it
86         /// if the counterparty's claim is reorged from the chain.
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, claim_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 /// The claim commonly referred to as the pre-signed second-stage HTLC transaction.
174 #[derive(Clone, PartialEq, Eq)]
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 #[derive(Clone, PartialEq, Eq)]
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                 tx_lock_time: PackedLockTime,
200         },
201 }
202
203 /// Represents the different ways an output can be claimed (i.e., spent to an address under our
204 /// control) onchain.
205 pub(crate) enum OnchainClaim {
206         /// A finalized transaction pending confirmation spending the output to claim.
207         Tx(Transaction),
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 /// OnchainTxHandler receives claiming requests, aggregates them if it's sound, broadcast and
214 /// do RBF bumping if possible.
215 #[derive(Clone)]
216 pub struct OnchainTxHandler<ChannelSigner: WriteableEcdsaChannelSigner> {
217         channel_value_satoshis: u64,
218         channel_keys_id: [u8; 32],
219         destination_script: Script,
220         holder_commitment: HolderCommitmentTransaction,
221         prev_holder_commitment: Option<HolderCommitmentTransaction>,
222
223         pub(super) signer: ChannelSigner,
224         pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
225
226         // Used to track claiming requests. If claim tx doesn't confirm before height timer expiration we need to bump
227         // it (RBF or CPFP). If an input has been part of an aggregate tx at first claim try, we need to keep it within
228         // another bumped aggregate tx to comply with RBF rules. We may have multiple claiming txn in the flight for the
229         // same set of outpoints. One of the outpoints may be spent by a transaction not issued by us. That's why at
230         // block connection we scan all inputs and if any of them is among a set of a claiming request we test for set
231         // equality between spending transaction and claim request. If true, it means transaction was one our claiming one
232         // after a security delay of 6 blocks we remove pending claim request. If false, it means transaction wasn't and
233         // we need to regenerate new claim request with reduced set of still-claimable outpoints.
234         // Key is identifier of the pending claim request, i.e the txid of the initial claiming transaction generated by
235         // us and is immutable until all outpoint of the claimable set are post-anti-reorg-delay solved.
236         // Entry is cache of elements need to generate a bumped claiming transaction (see ClaimTxBumpMaterial)
237         #[cfg(test)] // Used in functional_test to verify sanitization
238         pub(crate) pending_claim_requests: HashMap<ClaimId, PackageTemplate>,
239         #[cfg(not(test))]
240         pending_claim_requests: HashMap<ClaimId, PackageTemplate>,
241
242         // Used to track external events that need to be forwarded to the `ChainMonitor`. This `Vec`
243         // essentially acts as an insertion-ordered `HashMap` â€“ there should only ever be one occurrence
244         // of a `ClaimId`, which tracks its latest `ClaimEvent`, i.e., if a pending claim exists, and
245         // a new block has been connected, resulting in a new claim, the previous will be replaced with
246         // the new.
247         //
248         // These external events may be generated in the following cases:
249         //      - A channel has been force closed by broadcasting the holder's latest commitment transaction
250         //      - A block being connected/disconnected
251         //      - Learning the preimage for an HTLC we can claim onchain
252         pending_claim_events: Vec<(ClaimId, 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, (ClaimId, u32)>,
262         #[cfg(not(test))]
263         claimable_outpoints: HashMap<BitcoinOutPoint, (ClaimId, 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.channel_value_satoshis == other.channel_value_satoshis &&
276                         self.channel_keys_id == other.channel_keys_id &&
277                         self.destination_script == other.destination_script &&
278                         self.holder_commitment == other.holder_commitment &&
279                         self.prev_holder_commitment == other.prev_holder_commitment &&
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                 None::<Option<Vec<Option<(usize, Signature)>>>>.write(writer)?; // holder_htlc_sigs
298                 self.prev_holder_commitment.write(writer)?;
299                 None::<Option<Vec<Option<(usize, Signature)>>>>.write(writer)?; // prev_holder_htlc_sigs
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: Option<Vec<Option<(usize, Signature)>>> = Readable::read(reader)?;
355                 let prev_holder_commitment = Readable::read(reader)?;
356                 let _prev_holder_htlc_sigs: Option<Vec<Option<(usize, Signature)>>> = 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                         channel_value_satoshis,
418                         channel_keys_id,
419                         destination_script,
420                         holder_commitment,
421                         prev_holder_commitment,
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                         pending_claim_events: Vec::new(),
429                         secp_ctx,
430                 })
431         }
432 }
433
434 impl<ChannelSigner: WriteableEcdsaChannelSigner> OnchainTxHandler<ChannelSigner> {
435         pub(crate) fn new(
436                 channel_value_satoshis: u64, channel_keys_id: [u8; 32], destination_script: Script,
437                 signer: ChannelSigner, channel_parameters: ChannelTransactionParameters,
438                 holder_commitment: HolderCommitmentTransaction, secp_ctx: Secp256k1<secp256k1::All>
439         ) -> Self {
440                 OnchainTxHandler {
441                         channel_value_satoshis,
442                         channel_keys_id,
443                         destination_script,
444                         holder_commitment,
445                         prev_holder_commitment: None,
446                         signer,
447                         channel_transaction_parameters: channel_parameters,
448                         pending_claim_requests: HashMap::new(),
449                         claimable_outpoints: HashMap::new(),
450                         locktimed_packages: BTreeMap::new(),
451                         onchain_events_awaiting_threshold_conf: Vec::new(),
452                         pending_claim_events: Vec::new(),
453                         secp_ctx,
454                 }
455         }
456
457         pub(crate) fn get_prev_holder_commitment_to_self_value(&self) -> Option<u64> {
458                 self.prev_holder_commitment.as_ref().map(|commitment| commitment.to_broadcaster_value_sat())
459         }
460
461         pub(crate) fn get_cur_holder_commitment_to_self_value(&self) -> u64 {
462                 self.holder_commitment.to_broadcaster_value_sat()
463         }
464
465         pub(crate) fn get_and_clear_pending_claim_events(&mut self) -> Vec<(ClaimId, ClaimEvent)> {
466                 let mut events = Vec::new();
467                 swap(&mut events, &mut self.pending_claim_events);
468                 events
469         }
470
471         /// Triggers rebroadcasts/fee-bumps of pending claims from a force-closed channel. This is
472         /// crucial in preventing certain classes of pinning attacks, detecting substantial mempool
473         /// feerate changes between blocks, and ensuring reliability if broadcasting fails. We recommend
474         /// invoking this every 30 seconds, or lower if running in an environment with spotty
475         /// connections, like on mobile.
476         pub(crate) fn rebroadcast_pending_claims<B: Deref, F: Deref, L: Deref>(
477                 &mut self, current_height: u32, broadcaster: &B, fee_estimator: &LowerBoundedFeeEstimator<F>,
478                 logger: &L,
479         )
480         where
481                 B::Target: BroadcasterInterface,
482                 F::Target: FeeEstimator,
483                 L::Target: Logger,
484         {
485                 let mut bump_requests = Vec::with_capacity(self.pending_claim_requests.len());
486                 for (claim_id, request) in self.pending_claim_requests.iter() {
487                         let inputs = request.outpoints();
488                         log_info!(logger, "Triggering rebroadcast/fee-bump for request with inputs {:?}", inputs);
489                         bump_requests.push((*claim_id, request.clone()));
490                 }
491                 for (claim_id, request) in bump_requests {
492                         self.generate_claim(current_height, &request, false /* force_feerate_bump */, fee_estimator, logger)
493                                 .map(|(_, new_feerate, claim)| {
494                                         let mut bumped_feerate = false;
495                                         if let Some(mut_request) = self.pending_claim_requests.get_mut(&claim_id) {
496                                                 bumped_feerate = request.previous_feerate() > new_feerate;
497                                                 mut_request.set_feerate(new_feerate);
498                                         }
499                                         match claim {
500                                                 OnchainClaim::Tx(tx) => {
501                                                         let log_start = if bumped_feerate { "Broadcasting RBF-bumped" } else { "Rebroadcasting" };
502                                                         log_info!(logger, "{} onchain {}", log_start, log_tx!(tx));
503                                                         broadcaster.broadcast_transactions(&[&tx]);
504                                                 },
505                                                 OnchainClaim::Event(event) => {
506                                                         let log_start = if bumped_feerate { "Yielding fee-bumped" } else { "Replaying" };
507                                                         log_info!(logger, "{} onchain event to spend inputs {:?}", log_start,
508                                                                 request.outpoints());
509                                                         #[cfg(debug_assertions)] {
510                                                                 debug_assert!(request.requires_external_funding());
511                                                                 let num_existing = self.pending_claim_events.iter()
512                                                                         .filter(|entry| entry.0 == claim_id).count();
513                                                                 assert!(num_existing == 0 || num_existing == 1);
514                                                         }
515                                                         self.pending_claim_events.retain(|event| event.0 != claim_id);
516                                                         self.pending_claim_events.push((claim_id, event));
517                                                 }
518                                         }
519                                 });
520                 }
521         }
522
523         /// Lightning security model (i.e being able to redeem/timeout HTLC or penalize counterparty
524         /// onchain) lays on the assumption of claim transactions getting confirmed before timelock
525         /// expiration (CSV or CLTV following cases). In case of high-fee spikes, claim tx may get stuck
526         /// in the mempool, so you need to bump its feerate quickly using Replace-By-Fee or
527         /// Child-Pay-For-Parent.
528         ///
529         /// Panics if there are signing errors, because signing operations in reaction to on-chain
530         /// events are not expected to fail, and if they do, we may lose funds.
531         fn generate_claim<F: Deref, L: Deref>(
532                 &mut self, cur_height: u32, cached_request: &PackageTemplate, force_feerate_bump: bool,
533                 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L,
534         ) -> Option<(u32, u64, OnchainClaim)>
535         where
536                 F::Target: FeeEstimator,
537                 L::Target: Logger,
538         {
539                 let request_outpoints = cached_request.outpoints();
540                 if request_outpoints.is_empty() {
541                         // Don't prune pending claiming request yet, we may have to resurrect HTLCs. Untractable
542                         // packages cannot be aggregated and will never be split, so we cannot end up with an
543                         // empty claim.
544                         debug_assert!(cached_request.is_malleable());
545                         return None;
546                 }
547                 // If we've seen transaction inclusion in the chain for all outpoints in our request, we
548                 // don't need to continue generating more claims. We'll keep tracking the request to fully
549                 // remove it once it reaches the confirmation threshold, or to generate a new claim if the
550                 // transaction is reorged out.
551                 let mut all_inputs_have_confirmed_spend = true;
552                 for outpoint in request_outpoints.iter() {
553                         if let Some((request_claim_id, _)) = self.claimable_outpoints.get(*outpoint) {
554                                 // We check for outpoint spends within claims individually rather than as a set
555                                 // since requests can have outpoints split off.
556                                 if !self.onchain_events_awaiting_threshold_conf.iter()
557                                         .any(|event_entry| if let OnchainEvent::Claim { claim_id } = event_entry.event {
558                                                 *request_claim_id == claim_id
559                                         } else {
560                                                 // The onchain event is not a claim, keep seeking until we find one.
561                                                 false
562                                         })
563                                 {
564                                         // Either we had no `OnchainEvent::Claim`, or we did but none matched the
565                                         // outpoint's registered spend.
566                                         all_inputs_have_confirmed_spend = false;
567                                 }
568                         } else {
569                                 // The request's outpoint spend does not exist yet.
570                                 all_inputs_have_confirmed_spend = false;
571                         }
572                 }
573                 if all_inputs_have_confirmed_spend {
574                         return None;
575                 }
576
577                 // Compute new height timer to decide when we need to regenerate a new bumped version of the claim tx (if we
578                 // didn't receive confirmation of it before, or not enough reorg-safe depth on top of it).
579                 let new_timer = cached_request.get_height_timer(cur_height);
580                 if cached_request.is_malleable() {
581                         if cached_request.requires_external_funding() {
582                                 let target_feerate_sat_per_1000_weight = cached_request.compute_package_feerate(
583                                         fee_estimator, ConfirmationTarget::HighPriority, force_feerate_bump
584                                 );
585                                 if let Some(htlcs) = cached_request.construct_malleable_package_with_external_funding(self) {
586                                         return Some((
587                                                 new_timer,
588                                                 target_feerate_sat_per_1000_weight as u64,
589                                                 OnchainClaim::Event(ClaimEvent::BumpHTLC {
590                                                         target_feerate_sat_per_1000_weight,
591                                                         htlcs,
592                                                         tx_lock_time: PackedLockTime(cached_request.package_locktime(cur_height)),
593                                                 }),
594                                         ));
595                                 } else {
596                                         return None;
597                                 }
598                         }
599
600                         let predicted_weight = cached_request.package_weight(&self.destination_script);
601                         if let Some((output_value, new_feerate)) = cached_request.compute_package_output(
602                                 predicted_weight, self.destination_script.dust_value().to_sat(),
603                                 force_feerate_bump, fee_estimator, logger,
604                         ) {
605                                 assert!(new_feerate != 0);
606
607                                 let transaction = cached_request.finalize_malleable_package(
608                                         cur_height, self, output_value, self.destination_script.clone(), logger
609                                 ).unwrap();
610                                 log_trace!(logger, "...with timer {} and feerate {}", new_timer, new_feerate);
611                                 assert!(predicted_weight >= transaction.weight());
612                                 return Some((new_timer, new_feerate, OnchainClaim::Tx(transaction)));
613                         }
614                 } else {
615                         // Untractable packages cannot have their fees bumped through Replace-By-Fee. Some
616                         // packages may support fee bumping through Child-Pays-For-Parent, indicated by those
617                         // which require external funding.
618                         let mut inputs = cached_request.inputs();
619                         debug_assert_eq!(inputs.len(), 1);
620                         let tx = match cached_request.finalize_untractable_package(self, logger) {
621                                 Some(tx) => tx,
622                                 None => return None,
623                         };
624                         if !cached_request.requires_external_funding() {
625                                 return Some((new_timer, 0, OnchainClaim::Tx(tx)));
626                         }
627                         return inputs.find_map(|input| match input {
628                                 // Commitment inputs with anchors support are the only untractable inputs supported
629                                 // thus far that require external funding.
630                                 PackageSolvingData::HolderFundingOutput(output) => {
631                                         debug_assert_eq!(tx.txid(), self.holder_commitment.trust().txid(),
632                                                 "Holder commitment transaction mismatch");
633
634                                         let conf_target = ConfirmationTarget::HighPriority;
635                                         let package_target_feerate_sat_per_1000_weight = cached_request
636                                                 .compute_package_feerate(fee_estimator, conf_target, force_feerate_bump);
637                                         if let Some(input_amount_sat) = output.funding_amount {
638                                                 let fee_sat = input_amount_sat - tx.output.iter().map(|output| output.value).sum::<u64>();
639                                                 let commitment_tx_feerate_sat_per_1000_weight =
640                                                         compute_feerate_sat_per_1000_weight(fee_sat, tx.weight() as u64);
641                                                 if commitment_tx_feerate_sat_per_1000_weight >= package_target_feerate_sat_per_1000_weight {
642                                                         log_debug!(logger, "Pre-signed {} already has feerate {} sat/kW above required {} sat/kW",
643                                                                 log_tx!(tx), commitment_tx_feerate_sat_per_1000_weight,
644                                                                 package_target_feerate_sat_per_1000_weight);
645                                                         return Some((new_timer, 0, OnchainClaim::Tx(tx.clone())));
646                                                 }
647                                         }
648
649                                         // We'll locate an anchor output we can spend within the commitment transaction.
650                                         let funding_pubkey = &self.channel_transaction_parameters.holder_pubkeys.funding_pubkey;
651                                         match chan_utils::get_anchor_output(&tx, funding_pubkey) {
652                                                 // An anchor output was found, so we should yield a funding event externally.
653                                                 Some((idx, _)) => {
654                                                         // TODO: Use a lower confirmation target when both our and the
655                                                         // counterparty's latest commitment don't have any HTLCs present.
656                                                         Some((
657                                                                 new_timer,
658                                                                 package_target_feerate_sat_per_1000_weight as u64,
659                                                                 OnchainClaim::Event(ClaimEvent::BumpCommitment {
660                                                                         package_target_feerate_sat_per_1000_weight,
661                                                                         commitment_tx: tx.clone(),
662                                                                         anchor_output_idx: idx,
663                                                                 }),
664                                                         ))
665                                                 },
666                                                 // An anchor output was not found. There's nothing we can do other than
667                                                 // attempt to broadcast the transaction with its current fee rate and hope
668                                                 // it confirms. This is essentially the same behavior as a commitment
669                                                 // transaction without anchor outputs.
670                                                 None => Some((new_timer, 0, OnchainClaim::Tx(tx.clone()))),
671                                         }
672                                 },
673                                 _ => {
674                                         debug_assert!(false, "Only HolderFundingOutput inputs should be untractable and require external funding");
675                                         None
676                                 },
677                         })
678                 }
679                 None
680         }
681
682         /// Upon channelmonitor.block_connected(..) or upon provision of a preimage on the forward link
683         /// for this channel, provide new relevant on-chain transactions and/or new claim requests.
684         /// Together with `update_claims_view_from_matched_txn` this used to be named
685         /// `block_connected`, but it is now also used for claiming an HTLC output if we receive a
686         /// preimage after force-close.
687         ///
688         /// `conf_height` represents the height at which the request was generated. This
689         /// does not need to equal the current blockchain tip height, which should be provided via
690         /// `cur_height`, however it must never be higher than `cur_height`.
691         pub(crate) fn update_claims_view_from_requests<B: Deref, F: Deref, L: Deref>(
692                 &mut self, requests: Vec<PackageTemplate>, conf_height: u32, cur_height: u32,
693                 broadcaster: &B, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L
694         ) where
695                 B::Target: BroadcasterInterface,
696                 F::Target: FeeEstimator,
697                 L::Target: Logger,
698         {
699                 log_debug!(logger, "Updating claims view at height {} with {} claim requests", cur_height, requests.len());
700                 let mut preprocessed_requests = Vec::with_capacity(requests.len());
701                 let mut aggregated_request = None;
702
703                 // Try to aggregate outputs if their timelock expiration isn't imminent (package timelock
704                 // <= CLTV_SHARED_CLAIM_BUFFER) and they don't require an immediate nLockTime (aggregable).
705                 for req in requests {
706                         // Don't claim a outpoint twice that would be bad for privacy and may uselessly lock a CPFP input for a while
707                         if let Some(_) = self.claimable_outpoints.get(req.outpoints()[0]) {
708                                 log_info!(logger, "Ignoring second claim for outpoint {}:{}, already registered its claiming request", req.outpoints()[0].txid, req.outpoints()[0].vout);
709                         } else {
710                                 let timelocked_equivalent_package = self.locktimed_packages.iter().map(|v| v.1.iter()).flatten()
711                                         .find(|locked_package| locked_package.outpoints() == req.outpoints());
712                                 if let Some(package) = timelocked_equivalent_package {
713                                         log_info!(logger, "Ignoring second claim for outpoint {}:{}, we already have one which we're waiting on a timelock at {} for.",
714                                                 req.outpoints()[0].txid, req.outpoints()[0].vout, package.package_locktime(cur_height));
715                                         continue;
716                                 }
717
718                                 let package_locktime = req.package_locktime(cur_height);
719                                 if package_locktime > cur_height + 1 {
720                                         log_info!(logger, "Delaying claim of package until its timelock at {} (current height {}), the following outpoints are spent:", package_locktime, cur_height);
721                                         for outpoint in req.outpoints() {
722                                                 log_info!(logger, "  Outpoint {}", outpoint);
723                                         }
724                                         self.locktimed_packages.entry(package_locktime).or_insert(Vec::new()).push(req);
725                                         continue;
726                                 }
727
728                                 log_trace!(logger, "Test if outpoint can be aggregated with expiration {} against {}", req.timelock(), cur_height + CLTV_SHARED_CLAIM_BUFFER);
729                                 if req.timelock() <= cur_height + CLTV_SHARED_CLAIM_BUFFER || !req.aggregable() {
730                                         // Don't aggregate if outpoint package timelock is soon or marked as non-aggregable
731                                         preprocessed_requests.push(req);
732                                 } else if aggregated_request.is_none() {
733                                         aggregated_request = Some(req);
734                                 } else {
735                                         aggregated_request.as_mut().unwrap().merge_package(req);
736                                 }
737                         }
738                 }
739                 if let Some(req) = aggregated_request {
740                         preprocessed_requests.push(req);
741                 }
742
743                 // Claim everything up to and including `cur_height`
744                 let remaining_locked_packages = self.locktimed_packages.split_off(&(cur_height + 1));
745                 for (pop_height, mut entry) in self.locktimed_packages.iter_mut() {
746                         log_trace!(logger, "Restoring delayed claim of package(s) at their timelock at {}.", pop_height);
747                         preprocessed_requests.append(&mut entry);
748                 }
749                 self.locktimed_packages = remaining_locked_packages;
750
751                 // Generate claim transactions and track them to bump if necessary at
752                 // height timer expiration (i.e in how many blocks we're going to take action).
753                 for mut req in preprocessed_requests {
754                         if let Some((new_timer, new_feerate, claim)) = self.generate_claim(
755                                 cur_height, &req, true /* force_feerate_bump */, &*fee_estimator, &*logger,
756                         ) {
757                                 req.set_timer(new_timer);
758                                 req.set_feerate(new_feerate);
759                                 // Once a pending claim has an id assigned, it remains fixed until the claim is
760                                 // satisfied, regardless of whether the claim switches between different variants of
761                                 // `OnchainClaim`.
762                                 let claim_id = match claim {
763                                         OnchainClaim::Tx(tx) => {
764                                                 log_info!(logger, "Broadcasting onchain {}", log_tx!(tx));
765                                                 broadcaster.broadcast_transactions(&[&tx]);
766                                                 ClaimId(tx.txid().into_inner())
767                                         },
768                                         OnchainClaim::Event(claim_event) => {
769                                                 log_info!(logger, "Yielding onchain event to spend inputs {:?}", req.outpoints());
770                                                 let claim_id = match claim_event {
771                                                         ClaimEvent::BumpCommitment { ref commitment_tx, .. } =>
772                                                                 // For commitment claims, we can just use their txid as it should
773                                                                 // already be unique.
774                                                                 ClaimId(commitment_tx.txid().into_inner()),
775                                                         ClaimEvent::BumpHTLC { ref htlcs, .. } => {
776                                                                 // For HTLC claims, commit to the entire set of HTLC outputs to
777                                                                 // claim, which will always be unique per request. Once a claim ID
778                                                                 // is generated, it is assigned and remains unchanged, even if the
779                                                                 // underlying set of HTLCs changes.
780                                                                 let mut engine = Sha256::engine();
781                                                                 for htlc in htlcs {
782                                                                         engine.input(&htlc.commitment_txid.into_inner());
783                                                                         engine.input(&htlc.htlc.transaction_output_index.unwrap().to_be_bytes());
784                                                                 }
785                                                                 ClaimId(Sha256::from_engine(engine).into_inner())
786                                                         },
787                                                 };
788                                                 debug_assert!(self.pending_claim_requests.get(&claim_id).is_none());
789                                                 debug_assert_eq!(self.pending_claim_events.iter().filter(|entry| entry.0 == claim_id).count(), 0);
790                                                 self.pending_claim_events.push((claim_id, claim_event));
791                                                 claim_id
792                                         },
793                                 };
794                                 debug_assert!(self.pending_claim_requests.get(&claim_id).is_none());
795                                 for k in req.outpoints() {
796                                         log_info!(logger, "Registering claiming request for {}:{}", k.txid, k.vout);
797                                         self.claimable_outpoints.insert(k.clone(), (claim_id, conf_height));
798                                 }
799                                 self.pending_claim_requests.insert(claim_id, req);
800                         }
801                 }
802         }
803
804         /// Upon channelmonitor.block_connected(..) or upon provision of a preimage on the forward link
805         /// for this channel, provide new relevant on-chain transactions and/or new claim requests.
806         /// Together with `update_claims_view_from_requests` this used to be named `block_connected`,
807         /// but it is now also used for claiming an HTLC output if we receive a preimage after force-close.
808         ///
809         /// `conf_height` represents the height at which the transactions in `txn_matched` were
810         /// confirmed. This does not need to equal the current blockchain tip height, which should be
811         /// provided via `cur_height`, however it must never be higher than `cur_height`.
812         pub(crate) fn update_claims_view_from_matched_txn<B: Deref, F: Deref, L: Deref>(
813                 &mut self, txn_matched: &[&Transaction], conf_height: u32, conf_hash: BlockHash,
814                 cur_height: u32, broadcaster: &B, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L
815         ) where
816                 B::Target: BroadcasterInterface,
817                 F::Target: FeeEstimator,
818                 L::Target: Logger,
819         {
820                 log_debug!(logger, "Updating claims view at height {} with {} matched transactions in block {}", cur_height, txn_matched.len(), conf_height);
821                 let mut bump_candidates = HashMap::new();
822                 for tx in txn_matched {
823                         // Scan all input to verify is one of the outpoint spent is of interest for us
824                         let mut claimed_outputs_material = Vec::new();
825                         for inp in &tx.input {
826                                 if let Some((claim_id, _)) = self.claimable_outpoints.get(&inp.previous_output) {
827                                         // If outpoint has claim request pending on it...
828                                         if let Some(request) = self.pending_claim_requests.get_mut(claim_id) {
829                                                 //... we need to verify equality between transaction outpoints and claim request
830                                                 // outpoints to know if transaction is the original claim or a bumped one issued
831                                                 // by us.
832                                                 let mut are_sets_equal = true;
833                                                 let mut tx_inputs = tx.input.iter().map(|input| &input.previous_output).collect::<Vec<_>>();
834                                                 tx_inputs.sort_unstable();
835                                                 for request_input in request.outpoints() {
836                                                         if tx_inputs.binary_search(&request_input).is_err() {
837                                                                 are_sets_equal = false;
838                                                                 break;
839                                                         }
840                                                 }
841
842                                                 macro_rules! clean_claim_request_after_safety_delay {
843                                                         () => {
844                                                                 let entry = OnchainEventEntry {
845                                                                         txid: tx.txid(),
846                                                                         height: conf_height,
847                                                                         block_hash: Some(conf_hash),
848                                                                         event: OnchainEvent::Claim { claim_id: *claim_id }
849                                                                 };
850                                                                 if !self.onchain_events_awaiting_threshold_conf.contains(&entry) {
851                                                                         self.onchain_events_awaiting_threshold_conf.push(entry);
852                                                                 }
853                                                         }
854                                                 }
855
856                                                 // If this is our transaction (or our counterparty spent all the outputs
857                                                 // before we could anyway with same inputs order than us), wait for
858                                                 // ANTI_REORG_DELAY and clean the RBF tracking map.
859                                                 if are_sets_equal {
860                                                         clean_claim_request_after_safety_delay!();
861                                                 } else { // If false, generate new claim request with update outpoint set
862                                                         let mut at_least_one_drop = false;
863                                                         for input in tx.input.iter() {
864                                                                 if let Some(package) = request.split_package(&input.previous_output) {
865                                                                         claimed_outputs_material.push(package);
866                                                                         at_least_one_drop = true;
867                                                                 }
868                                                                 // If there are no outpoints left to claim in this request, drop it entirely after ANTI_REORG_DELAY.
869                                                                 if request.outpoints().is_empty() {
870                                                                         clean_claim_request_after_safety_delay!();
871                                                                 }
872                                                         }
873                                                         //TODO: recompute soonest_timelock to avoid wasting a bit on fees
874                                                         if at_least_one_drop {
875                                                                 bump_candidates.insert(*claim_id, request.clone());
876                                                                 // If we have any pending claim events for the request being updated
877                                                                 // that have yet to be consumed, we'll remove them since they will
878                                                                 // end up producing an invalid transaction by double spending
879                                                                 // input(s) that already have a confirmed spend. If such spend is
880                                                                 // reorged out of the chain, then we'll attempt to re-spend the
881                                                                 // inputs once we see it.
882                                                                 #[cfg(debug_assertions)] {
883                                                                         let existing = self.pending_claim_events.iter()
884                                                                                 .filter(|entry| entry.0 == *claim_id).count();
885                                                                         assert!(existing == 0 || existing == 1);
886                                                                 }
887                                                                 self.pending_claim_events.retain(|entry| entry.0 != *claim_id);
888                                                         }
889                                                 }
890                                                 break; //No need to iterate further, either tx is our or their
891                                         } else {
892                                                 panic!("Inconsistencies between pending_claim_requests map and claimable_outpoints map");
893                                         }
894                                 }
895                         }
896                         for package in claimed_outputs_material.drain(..) {
897                                 let entry = OnchainEventEntry {
898                                         txid: tx.txid(),
899                                         height: conf_height,
900                                         block_hash: Some(conf_hash),
901                                         event: OnchainEvent::ContentiousOutpoint { package },
902                                 };
903                                 if !self.onchain_events_awaiting_threshold_conf.contains(&entry) {
904                                         self.onchain_events_awaiting_threshold_conf.push(entry);
905                                 }
906                         }
907                 }
908
909                 // After security delay, either our claim tx got enough confs or outpoint is definetely out of reach
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.has_reached_confirmation_threshold(cur_height) {
914                                 match entry.event {
915                                         OnchainEvent::Claim { claim_id } => {
916                                                 // We may remove a whole set of claim outpoints here, as these one may have
917                                                 // been aggregated in a single tx and claimed so atomically
918                                                 if let Some(request) = self.pending_claim_requests.remove(&claim_id) {
919                                                         for outpoint in request.outpoints() {
920                                                                 log_debug!(logger, "Removing claim tracking for {} due to maturation of claim package {}.",
921                                                                         outpoint, log_bytes!(claim_id.0));
922                                                                 self.claimable_outpoints.remove(outpoint);
923                                                         }
924                                                         #[cfg(debug_assertions)] {
925                                                                 let num_existing = self.pending_claim_events.iter()
926                                                                         .filter(|entry| entry.0 == claim_id).count();
927                                                                 assert!(num_existing == 0 || num_existing == 1);
928                                                         }
929                                                         self.pending_claim_events.retain(|(id, _)| *id != claim_id);
930                                                 }
931                                         },
932                                         OnchainEvent::ContentiousOutpoint { package } => {
933                                                 log_debug!(logger, "Removing claim tracking due to maturation of claim tx for outpoints:");
934                                                 log_debug!(logger, " {:?}", package.outpoints());
935                                                 self.claimable_outpoints.remove(package.outpoints()[0]);
936                                         }
937                                 }
938                         } else {
939                                 self.onchain_events_awaiting_threshold_conf.push(entry);
940                         }
941                 }
942
943                 // Check if any pending claim request must be rescheduled
944                 for (claim_id, request) in self.pending_claim_requests.iter() {
945                         if cur_height >= request.timer() {
946                                 bump_candidates.insert(*claim_id, request.clone());
947                         }
948                 }
949
950                 // Build, bump and rebroadcast tx accordingly
951                 log_trace!(logger, "Bumping {} candidates", bump_candidates.len());
952                 for (claim_id, request) in bump_candidates.iter() {
953                         if let Some((new_timer, new_feerate, bump_claim)) = self.generate_claim(
954                                 cur_height, &request, true /* force_feerate_bump */, &*fee_estimator, &*logger,
955                         ) {
956                                 match bump_claim {
957                                         OnchainClaim::Tx(bump_tx) => {
958                                                 log_info!(logger, "Broadcasting RBF-bumped onchain {}", log_tx!(bump_tx));
959                                                 broadcaster.broadcast_transactions(&[&bump_tx]);
960                                         },
961                                         OnchainClaim::Event(claim_event) => {
962                                                 log_info!(logger, "Yielding RBF-bumped onchain event to spend inputs {:?}", request.outpoints());
963                                                 #[cfg(debug_assertions)] {
964                                                         let num_existing = self.pending_claim_events.iter().
965                                                                 filter(|entry| entry.0 == *claim_id).count();
966                                                         assert!(num_existing == 0 || num_existing == 1);
967                                                 }
968                                                 self.pending_claim_events.retain(|event| event.0 != *claim_id);
969                                                 self.pending_claim_events.push((*claim_id, claim_event));
970                                         },
971                                 }
972                                 if let Some(request) = self.pending_claim_requests.get_mut(claim_id) {
973                                         request.set_timer(new_timer);
974                                         request.set_feerate(new_feerate);
975                                 }
976                         }
977                 }
978         }
979
980         pub(crate) fn transaction_unconfirmed<B: Deref, F: Deref, L: Deref>(
981                 &mut self,
982                 txid: &Txid,
983                 broadcaster: B,
984                 fee_estimator: &LowerBoundedFeeEstimator<F>,
985                 logger: L,
986         ) where
987                 B::Target: BroadcasterInterface,
988                 F::Target: FeeEstimator,
989                 L::Target: Logger,
990         {
991                 let mut height = None;
992                 for entry in self.onchain_events_awaiting_threshold_conf.iter() {
993                         if entry.txid == *txid {
994                                 height = Some(entry.height);
995                                 break;
996                         }
997                 }
998
999                 if let Some(height) = height {
1000                         self.block_disconnected(height, broadcaster, fee_estimator, logger);
1001                 }
1002         }
1003
1004         pub(crate) fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, height: u32, broadcaster: B, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: L)
1005                 where B::Target: BroadcasterInterface,
1006                       F::Target: FeeEstimator,
1007                                         L::Target: Logger,
1008         {
1009                 let mut bump_candidates = HashMap::new();
1010                 let onchain_events_awaiting_threshold_conf =
1011                         self.onchain_events_awaiting_threshold_conf.drain(..).collect::<Vec<_>>();
1012                 for entry in onchain_events_awaiting_threshold_conf {
1013                         if entry.height >= height {
1014                                 //- our claim tx on a commitment tx output
1015                                 //- resurect outpoint back in its claimable set and regenerate tx
1016                                 match entry.event {
1017                                         OnchainEvent::ContentiousOutpoint { package } => {
1018                                                 if let Some(pending_claim) = self.claimable_outpoints.get(package.outpoints()[0]) {
1019                                                         if let Some(request) = self.pending_claim_requests.get_mut(&pending_claim.0) {
1020                                                                 request.merge_package(package);
1021                                                                 // Using a HashMap guarantee us than if we have multiple outpoints getting
1022                                                                 // resurrected only one bump claim tx is going to be broadcast
1023                                                                 bump_candidates.insert(pending_claim.clone(), request.clone());
1024                                                         }
1025                                                 }
1026                                         },
1027                                         _ => {},
1028                                 }
1029                         } else {
1030                                 self.onchain_events_awaiting_threshold_conf.push(entry);
1031                         }
1032                 }
1033                 for ((_claim_id, _), ref mut request) in bump_candidates.iter_mut() {
1034                         // `height` is the height being disconnected, so our `current_height` is 1 lower.
1035                         let current_height = height - 1;
1036                         if let Some((new_timer, new_feerate, bump_claim)) = self.generate_claim(
1037                                 current_height, &request, true /* force_feerate_bump */, fee_estimator, &&*logger
1038                         ) {
1039                                 request.set_timer(new_timer);
1040                                 request.set_feerate(new_feerate);
1041                                 match bump_claim {
1042                                         OnchainClaim::Tx(bump_tx) => {
1043                                                 log_info!(logger, "Broadcasting onchain {}", log_tx!(bump_tx));
1044                                                 broadcaster.broadcast_transactions(&[&bump_tx]);
1045                                         },
1046                                         OnchainClaim::Event(claim_event) => {
1047                                                 log_info!(logger, "Yielding onchain event after reorg to spend inputs {:?}", request.outpoints());
1048                                                 #[cfg(debug_assertions)] {
1049                                                         let num_existing = self.pending_claim_events.iter()
1050                                                                 .filter(|entry| entry.0 == *_claim_id).count();
1051                                                         assert!(num_existing == 0 || num_existing == 1);
1052                                                 }
1053                                                 self.pending_claim_events.retain(|event| event.0 != *_claim_id);
1054                                                 self.pending_claim_events.push((*_claim_id, claim_event));
1055                                         },
1056                                 }
1057                         }
1058                 }
1059                 for (ancestor_claim_txid, request) in bump_candidates.drain() {
1060                         self.pending_claim_requests.insert(ancestor_claim_txid.0, request);
1061                 }
1062                 //TODO: if we implement cross-block aggregated claim transaction we need to refresh set of outpoints and regenerate tx but
1063                 // right now if one of the outpoint get disconnected, just erase whole pending claim request.
1064                 let mut remove_request = Vec::new();
1065                 self.claimable_outpoints.retain(|_, ref v|
1066                         if v.1 >= height {
1067                         remove_request.push(v.0.clone());
1068                         false
1069                         } else { true });
1070                 for req in remove_request {
1071                         self.pending_claim_requests.remove(&req);
1072                 }
1073         }
1074
1075         pub(crate) fn is_output_spend_pending(&self, outpoint: &BitcoinOutPoint) -> bool {
1076                 self.claimable_outpoints.get(outpoint).is_some()
1077         }
1078
1079         pub(crate) fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
1080                 let mut txids: Vec<(Txid, Option<BlockHash>)> = self.onchain_events_awaiting_threshold_conf
1081                         .iter()
1082                         .map(|entry| (entry.txid, entry.block_hash))
1083                         .collect();
1084                 txids.sort_unstable_by_key(|(txid, _)| *txid);
1085                 txids.dedup();
1086                 txids
1087         }
1088
1089         pub(crate) fn provide_latest_holder_tx(&mut self, tx: HolderCommitmentTransaction) {
1090                 self.prev_holder_commitment = Some(replace(&mut self.holder_commitment, tx));
1091         }
1092
1093         pub(crate) fn get_unsigned_holder_commitment_tx(&self) -> &Transaction {
1094                 &self.holder_commitment.trust().built_transaction().transaction
1095         }
1096
1097         //TODO: getting lastest holder transactions should be infallible and result in us "force-closing the channel", but we may
1098         // have empty holder commitment transaction if a ChannelMonitor is asked to force-close just after OutboundV1Channel::get_funding_created,
1099         // before providing a initial commitment transaction. For outbound channel, init ChannelMonitor at Channel::funding_signed, there is nothing
1100         // to monitor before.
1101         pub(crate) fn get_fully_signed_holder_tx(&mut self, funding_redeemscript: &Script) -> Transaction {
1102                 let sig = self.signer.sign_holder_commitment(&self.holder_commitment, &self.secp_ctx).expect("signing holder commitment");
1103                 self.holder_commitment.add_holder_sig(funding_redeemscript, sig)
1104         }
1105
1106         #[cfg(any(test, feature="unsafe_revoked_tx_signing"))]
1107         pub(crate) fn get_fully_signed_copy_holder_tx(&mut self, funding_redeemscript: &Script) -> Transaction {
1108                 let sig = self.signer.unsafe_sign_holder_commitment(&self.holder_commitment, &self.secp_ctx).expect("sign holder commitment");
1109                 self.holder_commitment.add_holder_sig(funding_redeemscript, sig)
1110         }
1111
1112         pub(crate) fn get_fully_signed_htlc_tx(&mut self, outp: &::bitcoin::OutPoint, preimage: &Option<PaymentPreimage>) -> Option<Transaction> {
1113                 let get_signed_htlc_tx = |holder_commitment: &HolderCommitmentTransaction| {
1114                         let trusted_tx = holder_commitment.trust();
1115                         if trusted_tx.txid() != outp.txid {
1116                                 return None;
1117                         }
1118                         let (htlc_idx, htlc) = trusted_tx.htlcs().iter().enumerate()
1119                                 .find(|(_, htlc)| htlc.transaction_output_index.unwrap() == outp.vout)
1120                                 .unwrap();
1121                         let counterparty_htlc_sig = holder_commitment.counterparty_htlc_sigs[htlc_idx];
1122                         let mut htlc_tx = trusted_tx.build_unsigned_htlc_tx(
1123                                 &self.channel_transaction_parameters.as_holder_broadcastable(), htlc_idx, preimage,
1124                         );
1125
1126                         let htlc_descriptor = HTLCDescriptor {
1127                                 channel_derivation_parameters: ChannelDerivationParameters {
1128                                         value_satoshis: self.channel_value_satoshis,
1129                                         keys_id: self.channel_keys_id,
1130                                         transaction_parameters: self.channel_transaction_parameters.clone(),
1131                                 },
1132                                 commitment_txid: trusted_tx.txid(),
1133                                 per_commitment_number: trusted_tx.commitment_number(),
1134                                 per_commitment_point: trusted_tx.per_commitment_point(),
1135                                 feerate_per_kw: trusted_tx.feerate_per_kw(),
1136                                 htlc: htlc.clone(),
1137                                 preimage: preimage.clone(),
1138                                 counterparty_sig: counterparty_htlc_sig.clone(),
1139                         };
1140                         let htlc_sig = self.signer.sign_holder_htlc_transaction(&htlc_tx, 0, &htlc_descriptor, &self.secp_ctx).unwrap();
1141                         htlc_tx.input[0].witness = trusted_tx.build_htlc_input_witness(
1142                                 htlc_idx, &counterparty_htlc_sig, &htlc_sig, preimage,
1143                         );
1144                         Some(htlc_tx)
1145                 };
1146
1147                 // Check if the HTLC spends from the current holder commitment first, or the previous.
1148                 get_signed_htlc_tx(&self.holder_commitment)
1149                         .or_else(|| self.prev_holder_commitment.as_ref().and_then(|prev_holder_commitment| get_signed_htlc_tx(prev_holder_commitment)))
1150         }
1151
1152         pub(crate) fn generate_external_htlc_claim(
1153                 &self, outp: &::bitcoin::OutPoint, preimage: &Option<PaymentPreimage>
1154         ) -> Option<ExternalHTLCClaim> {
1155                 let find_htlc = |holder_commitment: &HolderCommitmentTransaction| -> Option<ExternalHTLCClaim> {
1156                         let trusted_tx = holder_commitment.trust();
1157                         if outp.txid != trusted_tx.txid() {
1158                                 return None;
1159                         }
1160                         trusted_tx.htlcs().iter().enumerate()
1161                                 .find(|(_, htlc)| if let Some(output_index) = htlc.transaction_output_index {
1162                                         output_index == outp.vout
1163                                 } else {
1164                                         false
1165                                 })
1166                                 .map(|(htlc_idx, htlc)| {
1167                                         let counterparty_htlc_sig = holder_commitment.counterparty_htlc_sigs[htlc_idx];
1168                                         ExternalHTLCClaim {
1169                                                 commitment_txid: trusted_tx.txid(),
1170                                                 per_commitment_number: trusted_tx.commitment_number(),
1171                                                 htlc: htlc.clone(),
1172                                                 preimage: *preimage,
1173                                                 counterparty_sig: counterparty_htlc_sig,
1174                                         }
1175                                 })
1176                 };
1177                 // Check if the HTLC spends from the current holder commitment or the previous one otherwise.
1178                 find_htlc(&self.holder_commitment)
1179                         .or_else(|| self.prev_holder_commitment.as_ref().map(|c| find_htlc(c)).flatten())
1180         }
1181
1182         pub(crate) fn channel_type_features(&self) -> &ChannelTypeFeatures {
1183                 &self.channel_transaction_parameters.channel_type_features
1184         }
1185 }