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