_ Git - rust-lightning/blob - lightning/src/ln/onchaintx.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! The logic to build claims and bump in-flight transactions until confirmations.
  11 //!
  12 //! OnchainTxHandler objects are fully-part of ChannelMonitor and encapsulates all
  13 //! building, tracking, bumping and notifications functions.
  14
  15 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut, SigHashType};
  16 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
  17 use bitcoin::blockdata::script::Script;
  18
  19 use bitcoin::hash_types::Txid;
  20
  21 use bitcoin::secp256k1::{Secp256k1, Signature};
  22 use bitcoin::secp256k1;
  23
  24 use ln::msgs::DecodeError;
  25 use ln::channelmanager::PaymentPreimage;
  26 use ln::chan_utils;
  27 use ln::chan_utils::{TxCreationKeys, ChannelTransactionParameters, HolderCommitmentTransaction};
  28 use chain::chaininterface::{FeeEstimator, BroadcasterInterface, ConfirmationTarget, MIN_RELAY_FEE_SAT_PER_1000_WEIGHT};
  29 use chain::channelmonitor::{ANTI_REORG_DELAY, CLTV_SHARED_CLAIM_BUFFER, InputMaterial, ClaimRequest};
  30 use chain::keysinterface::{ChannelKeys, KeysInterface};
  31 use util::logger::Logger;
  32 use util::ser::{Readable, ReadableArgs, Writer, Writeable, VecWriter};
  33 use util::byte_utils;
  34
  35 use std::collections::{HashMap, hash_map};
  36 use std::cmp;
  37 use std::ops::Deref;
  38
  39 const MAX_ALLOC_SIZE: usize = 64*1024;
  40
  41 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
  42 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
  43 #[derive(Clone, PartialEq)]
  44 enum OnchainEvent {
  45         /// Outpoint under claim process by our own tx, once this one get enough confirmations, we remove it from
  46         /// bump-txn candidate buffer.
  47         Claim {
  48                 claim_request: Txid,
  49         },
  50         /// Claim tx aggregate multiple claimable outpoints. One of the outpoint may be claimed by a counterparty party tx.
  51         /// In this case, we need to drop the outpoint and regenerate a new claim tx. By safety, we keep tracking
  52         /// the outpoint to be sure to resurect it back to the claim tx if reorgs happen.
  53         ContentiousOutpoint {
  54                 outpoint: BitcoinOutPoint,
  55                 input_material: InputMaterial,
  56         }
  57 }
  58
  59 /// Higher-level cache structure needed to re-generate bumped claim txn if needed
  60 #[derive(Clone, PartialEq)]
  61 pub struct ClaimTxBumpMaterial {
  62         // At every block tick, used to check if pending claiming tx is taking too
  63         // much time for confirmation and we need to bump it.
  64         height_timer: Option<u32>,
  65         // Tracked in case of reorg to wipe out now-superflous bump material
  66         feerate_previous: u32,
  67         // Soonest timelocks among set of outpoints claimed, used to compute
  68         // a priority of not feerate
  69         soonest_timelock: u32,
  70         // Cache of script, pubkey, sig or key to solve claimable outputs scriptpubkey.
  71         per_input_material: HashMap<BitcoinOutPoint, InputMaterial>,
  72 }
  73
  74 impl Writeable for ClaimTxBumpMaterial  {
  75         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
  76                 self.height_timer.write(writer)?;
  77                 writer.write_all(&byte_utils::be32_to_array(self.feerate_previous))?;
  78                 writer.write_all(&byte_utils::be32_to_array(self.soonest_timelock))?;
  79                 writer.write_all(&byte_utils::be64_to_array(self.per_input_material.len() as u64))?;
  80                 for (outp, tx_material) in self.per_input_material.iter() {
  81                         outp.write(writer)?;
  82                         tx_material.write(writer)?;
  83                 }
  84                 Ok(())
  85         }
  86 }
  87
  88 impl Readable for ClaimTxBumpMaterial {
  89         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
  90                 let height_timer = Readable::read(reader)?;
  91                 let feerate_previous = Readable::read(reader)?;
  92                 let soonest_timelock = Readable::read(reader)?;
  93                 let per_input_material_len: u64 = Readable::read(reader)?;
  94                 let mut per_input_material = HashMap::with_capacity(cmp::min(per_input_material_len as usize, MAX_ALLOC_SIZE / 128));
  95                 for _ in 0 ..per_input_material_len {
  96                         let outpoint = Readable::read(reader)?;
  97                         let input_material = Readable::read(reader)?;
  98                         per_input_material.insert(outpoint, input_material);
  99                 }
 100                 Ok(Self { height_timer, feerate_previous, soonest_timelock, per_input_material })
 101         }
 102 }
 103
 104 #[derive(PartialEq, Clone, Copy)]
 105 pub(crate) enum InputDescriptors {
 106         RevokedOfferedHTLC,
 107         RevokedReceivedHTLC,
 108         OfferedHTLC,
 109         ReceivedHTLC,
 110         RevokedOutput, // either a revoked to_holder output on commitment tx, a revoked HTLC-Timeout output or a revoked HTLC-Success output
 111 }
 112
 113 impl Writeable for InputDescriptors {
 114         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
 115                 match self {
 116                         &InputDescriptors::RevokedOfferedHTLC => {
 117                                 writer.write_all(&[0; 1])?;
 118                         },
 119                         &InputDescriptors::RevokedReceivedHTLC => {
 120                                 writer.write_all(&[1; 1])?;
 121                         },
 122                         &InputDescriptors::OfferedHTLC => {
 123                                 writer.write_all(&[2; 1])?;
 124                         },
 125                         &InputDescriptors::ReceivedHTLC => {
 126                                 writer.write_all(&[3; 1])?;
 127                         }
 128                         &InputDescriptors::RevokedOutput => {
 129                                 writer.write_all(&[4; 1])?;
 130                         }
 131                 }
 132                 Ok(())
 133         }
 134 }
 135
 136 impl Readable for InputDescriptors {
 137         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
 138                 let input_descriptor = match <u8 as Readable>::read(reader)? {
 139                         0 => {
 140                                 InputDescriptors::RevokedOfferedHTLC
 141                         },
 142                         1 => {
 143                                 InputDescriptors::RevokedReceivedHTLC
 144                         },
 145                         2 => {
 146                                 InputDescriptors::OfferedHTLC
 147                         },
 148                         3 => {
 149                                 InputDescriptors::ReceivedHTLC
 150                         },
 151                         4 => {
 152                                 InputDescriptors::RevokedOutput
 153                         }
 154                         _ => return Err(DecodeError::InvalidValue),
 155                 };
 156                 Ok(input_descriptor)
 157         }
 158 }
 159
 160 macro_rules! subtract_high_prio_fee {
 161         ($logger: ident, $fee_estimator: expr, $value: expr, $predicted_weight: expr, $used_feerate: expr) => {
 162                 {
 163                         $used_feerate = $fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority).into();
 164                         let mut fee = $used_feerate as u64 * $predicted_weight / 1000;
 165                         if $value <= fee {
 166                                 $used_feerate = $fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal).into();
 167                                 fee = $used_feerate as u64 * $predicted_weight / 1000;
 168                                 if $value <= fee.into() {
 169                                         $used_feerate = $fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background).into();
 170                                         fee = $used_feerate as u64 * $predicted_weight / 1000;
 171                                         if $value <= fee {
 172                                                 log_error!($logger, "Failed to generate an on-chain punishment tx as even low priority fee ({} sat) was more than the entire claim balance ({} sat)",
 173                                                         fee, $value);
 174                                                 false
 175                                         } else {
 176                                                 log_warn!($logger, "Used low priority fee for on-chain punishment tx as high priority fee was more than the entire claim balance ({} sat)",
 177                                                         $value);
 178                                                 $value -= fee;
 179                                                 true
 180                                         }
 181                                 } else {
 182                                         log_warn!($logger, "Used medium priority fee for on-chain punishment tx as high priority fee was more than the entire claim balance ({} sat)",
 183                                                 $value);
 184                                         $value -= fee;
 185                                         true
 186                                 }
 187                         } else {
 188                                 $value -= fee;
 189                                 true
 190                         }
 191                 }
 192         }
 193 }
 194
 195 impl Readable for Option<Vec<Option<(usize, Signature)>>> {
 196         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
 197                 match Readable::read(reader)? {
 198                         0u8 => Ok(None),
 199                         1u8 => {
 200                                 let vlen: u64 = Readable::read(reader)?;
 201                                 let mut ret = Vec::with_capacity(cmp::min(vlen as usize, MAX_ALLOC_SIZE / ::std::mem::size_of::<Option<(usize, Signature)>>()));
 202                                 for _ in 0..vlen {
 203                                         ret.push(match Readable::read(reader)? {
 204                                                 0u8 => None,
 205                                                 1u8 => Some((<u64 as Readable>::read(reader)? as usize, Readable::read(reader)?)),
 206                                                 _ => return Err(DecodeError::InvalidValue)
 207                                         });
 208                                 }
 209                                 Ok(Some(ret))
 210                         },
 211                         _ => Err(DecodeError::InvalidValue),
 212                 }
 213         }
 214 }
 215
 216 impl Writeable for Option<Vec<Option<(usize, Signature)>>> {
 217         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
 218                 match self {
 219                         &Some(ref vec) => {
 220                                 1u8.write(writer)?;
 221                                 (vec.len() as u64).write(writer)?;
 222                                 for opt in vec.iter() {
 223                                         match opt {
 224                                                 &Some((ref idx, ref sig)) => {
 225                                                         1u8.write(writer)?;
 226                                                         (*idx as u64).write(writer)?;
 227                                                         sig.write(writer)?;
 228                                                 },
 229                                                 &None => 0u8.write(writer)?,
 230                                         }
 231                                 }
 232                         },
 233                         &None => 0u8.write(writer)?,
 234                 }
 235                 Ok(())
 236         }
 237 }
 238
 239
 240 /// OnchainTxHandler receives claiming requests, aggregates them if it's sound, broadcast and
 241 /// do RBF bumping if possible.
 242 pub struct OnchainTxHandler<ChanSigner: ChannelKeys> {
 243         destination_script: Script,
 244         holder_commitment: Option<HolderCommitmentTransaction>,
 245         // holder_htlc_sigs and prev_holder_htlc_sigs are in the order as they appear in the commitment
 246         // transaction outputs (hence the Option<>s inside the Vec). The first usize is the index in
 247         // the set of HTLCs in the HolderCommitmentTransaction.
 248         holder_htlc_sigs: Option<Vec<Option<(usize, Signature)>>>,
 249         prev_holder_commitment: Option<HolderCommitmentTransaction>,
 250         prev_holder_htlc_sigs: Option<Vec<Option<(usize, Signature)>>>,
 251
 252         key_storage: ChanSigner,
 253         pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
 254
 255         // Used to track claiming requests. If claim tx doesn't confirm before height timer expiration we need to bump
 256         // it (RBF or CPFP). If an input has been part of an aggregate tx at first claim try, we need to keep it within
 257         // another bumped aggregate tx to comply with RBF rules. We may have multiple claiming txn in the flight for the
 258         // same set of outpoints. One of the outpoints may be spent by a transaction not issued by us. That's why at
 259         // block connection we scan all inputs and if any of them is among a set of a claiming request we test for set
 260         // equality between spending transaction and claim request. If true, it means transaction was one our claiming one
 261         // after a security delay of 6 blocks we remove pending claim request. If false, it means transaction wasn't and
 262         // we need to regenerate new claim request with reduced set of still-claimable outpoints.
 263         // Key is identifier of the pending claim request, i.e the txid of the initial claiming transaction generated by
 264         // us and is immutable until all outpoint of the claimable set are post-anti-reorg-delay solved.
 265         // Entry is cache of elements need to generate a bumped claiming transaction (see ClaimTxBumpMaterial)
 266         #[cfg(test)] // Used in functional_test to verify sanitization
 267         pub pending_claim_requests: HashMap<Txid, ClaimTxBumpMaterial>,
 268         #[cfg(not(test))]
 269         pending_claim_requests: HashMap<Txid, ClaimTxBumpMaterial>,
 270
 271         // Used to link outpoints claimed in a connected block to a pending claim request.
 272         // Key is outpoint than monitor parsing has detected we have keys/scripts to claim
 273         // Value is (pending claim request identifier, confirmation_block), identifier
 274         // is txid of the initial claiming transaction and is immutable until outpoint is
 275         // post-anti-reorg-delay solved, confirmaiton_block is used to erase entry if
 276         // block with output gets disconnected.
 277         #[cfg(test)] // Used in functional_test to verify sanitization
 278         pub claimable_outpoints: HashMap<BitcoinOutPoint, (Txid, u32)>,
 279         #[cfg(not(test))]
 280         claimable_outpoints: HashMap<BitcoinOutPoint, (Txid, u32)>,
 281
 282         onchain_events_waiting_threshold_conf: HashMap<u32, Vec<OnchainEvent>>,
 283
 284         latest_height: u32,
 285
 286         secp_ctx: Secp256k1<secp256k1::All>,
 287 }
 288
 289 impl<ChanSigner: ChannelKeys> OnchainTxHandler<ChanSigner> {
 290         pub(crate) fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
 291                 self.destination_script.write(writer)?;
 292                 self.holder_commitment.write(writer)?;
 293                 self.holder_htlc_sigs.write(writer)?;
 294                 self.prev_holder_commitment.write(writer)?;
 295                 self.prev_holder_htlc_sigs.write(writer)?;
 296
 297                 self.channel_transaction_parameters.write(writer)?;
 298
 299                 let mut key_data = VecWriter(Vec::new());
 300                 self.key_storage.write(&mut key_data)?;
 301                 assert!(key_data.0.len() < std::usize::MAX);
 302                 assert!(key_data.0.len() < std::u32::MAX as usize);
 303                 (key_data.0.len() as u32).write(writer)?;
 304                 writer.write_all(&key_data.0[..])?;
 305
 306                 writer.write_all(&byte_utils::be64_to_array(self.pending_claim_requests.len() as u64))?;
 307                 for (ref ancestor_claim_txid, claim_tx_data) in self.pending_claim_requests.iter() {
 308                         ancestor_claim_txid.write(writer)?;
 309                         claim_tx_data.write(writer)?;
 310                 }
 311
 312                 writer.write_all(&byte_utils::be64_to_array(self.claimable_outpoints.len() as u64))?;
 313                 for (ref outp, ref claim_and_height) in self.claimable_outpoints.iter() {
 314                         outp.write(writer)?;
 315                         claim_and_height.0.write(writer)?;
 316                         claim_and_height.1.write(writer)?;
 317                 }
 318
 319                 writer.write_all(&byte_utils::be64_to_array(self.onchain_events_waiting_threshold_conf.len() as u64))?;
 320                 for (ref target, ref events) in self.onchain_events_waiting_threshold_conf.iter() {
 321                         writer.write_all(&byte_utils::be32_to_array(**target))?;
 322                         writer.write_all(&byte_utils::be64_to_array(events.len() as u64))?;
 323                         for ev in events.iter() {
 324                                 match *ev {
 325                                         OnchainEvent::Claim { ref claim_request } => {
 326                                                 writer.write_all(&[0; 1])?;
 327                                                 claim_request.write(writer)?;
 328                                         },
 329                                         OnchainEvent::ContentiousOutpoint { ref outpoint, ref input_material } => {
 330                                                 writer.write_all(&[1; 1])?;
 331                                                 outpoint.write(writer)?;
 332                                                 input_material.write(writer)?;
 333                                         }
 334                                 }
 335                         }
 336                 }
 337                 self.latest_height.write(writer)?;
 338                 Ok(())
 339         }
 340 }
 341
 342 impl<'a, K: KeysInterface> ReadableArgs<&'a K> for OnchainTxHandler<K::ChanKeySigner> {
 343         fn read<R: ::std::io::Read>(reader: &mut R, keys_manager: &'a K) -> Result<Self, DecodeError> {
 344                 let destination_script = Readable::read(reader)?;
 345
 346                 let holder_commitment = Readable::read(reader)?;
 347                 let holder_htlc_sigs = Readable::read(reader)?;
 348                 let prev_holder_commitment = Readable::read(reader)?;
 349                 let prev_holder_htlc_sigs = Readable::read(reader)?;
 350
 351                 let channel_parameters = Readable::read(reader)?;
 352
 353                 let keys_len: u32 = Readable::read(reader)?;
 354                 let mut keys_data = Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE));
 355                 while keys_data.len() != keys_len as usize {
 356                         // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
 357                         let mut data = [0; 1024];
 358                         let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.len())];
 359                         reader.read_exact(read_slice)?;
 360                         keys_data.extend_from_slice(read_slice);
 361                 }
 362                 let key_storage = keys_manager.read_chan_signer(&keys_data)?;
 363
 364                 let pending_claim_requests_len: u64 = Readable::read(reader)?;
 365                 let mut pending_claim_requests = HashMap::with_capacity(cmp::min(pending_claim_requests_len as usize, MAX_ALLOC_SIZE / 128));
 366                 for _ in 0..pending_claim_requests_len {
 367                         pending_claim_requests.insert(Readable::read(reader)?, Readable::read(reader)?);
 368                 }
 369
 370                 let claimable_outpoints_len: u64 = Readable::read(reader)?;
 371                 let mut claimable_outpoints = HashMap::with_capacity(cmp::min(pending_claim_requests_len as usize, MAX_ALLOC_SIZE / 128));
 372                 for _ in 0..claimable_outpoints_len {
 373                         let outpoint = Readable::read(reader)?;
 374                         let ancestor_claim_txid = Readable::read(reader)?;
 375                         let height = Readable::read(reader)?;
 376                         claimable_outpoints.insert(outpoint, (ancestor_claim_txid, height));
 377                 }
 378                 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
 379                 let mut onchain_events_waiting_threshold_conf = HashMap::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
 380                 for _ in 0..waiting_threshold_conf_len {
 381                         let height_target = Readable::read(reader)?;
 382                         let events_len: u64 = Readable::read(reader)?;
 383                         let mut events = Vec::with_capacity(cmp::min(events_len as usize, MAX_ALLOC_SIZE / 128));
 384                         for _ in 0..events_len {
 385                                 let ev = match <u8 as Readable>::read(reader)? {
 386                                         0 => {
 387                                                 let claim_request = Readable::read(reader)?;
 388                                                 OnchainEvent::Claim {
 389                                                         claim_request
 390                                                 }
 391                                         },
 392                                         1 => {
 393                                                 let outpoint = Readable::read(reader)?;
 394                                                 let input_material = Readable::read(reader)?;
 395                                                 OnchainEvent::ContentiousOutpoint {
 396                                                         outpoint,
 397                                                         input_material
 398                                                 }
 399                                         }
 400                                         _ => return Err(DecodeError::InvalidValue),
 401                                 };
 402                                 events.push(ev);
 403                         }
 404                         onchain_events_waiting_threshold_conf.insert(height_target, events);
 405                 }
 406                 let latest_height = Readable::read(reader)?;
 407
 408                 Ok(OnchainTxHandler {
 409                         destination_script,
 410                         holder_commitment,
 411                         holder_htlc_sigs,
 412                         prev_holder_commitment,
 413                         prev_holder_htlc_sigs,
 414                         key_storage,
 415                         channel_transaction_parameters: channel_parameters,
 416                         claimable_outpoints,
 417                         pending_claim_requests,
 418                         onchain_events_waiting_threshold_conf,
 419                         latest_height,
 420                         secp_ctx: Secp256k1::new(),
 421                 })
 422         }
 423 }
 424
 425 impl<ChanSigner: ChannelKeys> OnchainTxHandler<ChanSigner> {
 426         pub(crate) fn new(destination_script: Script, keys: ChanSigner, channel_parameters: ChannelTransactionParameters) -> Self {
 427
 428                 let key_storage = keys;
 429
 430                 OnchainTxHandler {
 431                         destination_script,
 432                         holder_commitment: None,
 433                         holder_htlc_sigs: None,
 434                         prev_holder_commitment: None,
 435                         prev_holder_htlc_sigs: None,
 436                         key_storage,
 437                         channel_transaction_parameters: channel_parameters,
 438                         pending_claim_requests: HashMap::new(),
 439                         claimable_outpoints: HashMap::new(),
 440                         onchain_events_waiting_threshold_conf: HashMap::new(),
 441                         latest_height: 0,
 442
 443                         secp_ctx: Secp256k1::new(),
 444                 }
 445         }
 446
 447         pub(crate) fn get_witnesses_weight(inputs: &[InputDescriptors]) -> usize {
 448                 let mut tx_weight = 2; // count segwit flags
 449                 for inp in inputs {
 450                         // We use expected weight (and not actual) as signatures and time lock delays may vary
 451                         tx_weight +=  match inp {
 452                                 // number_of_witness_elements + sig_length + revocation_sig + pubkey_length + revocationpubkey + witness_script_length + witness_script
 453                                 &InputDescriptors::RevokedOfferedHTLC => {
 454                                         1 + 1 + 73 + 1 + 33 + 1 + 133
 455                                 },
 456                                 // number_of_witness_elements + sig_length + revocation_sig + pubkey_length + revocationpubkey + witness_script_length + witness_script
 457                                 &InputDescriptors::RevokedReceivedHTLC => {
 458                                         1 + 1 + 73 + 1 + 33 + 1 + 139
 459                                 },
 460                                 // number_of_witness_elements + sig_length + counterpartyhtlc_sig  + preimage_length + preimage + witness_script_length + witness_script
 461                                 &InputDescriptors::OfferedHTLC => {
 462                                         1 + 1 + 73 + 1 + 32 + 1 + 133
 463                                 },
 464                                 // number_of_witness_elements + sig_length + revocation_sig + pubkey_length + revocationpubkey + witness_script_length + witness_script
 465                                 &InputDescriptors::ReceivedHTLC => {
 466                                         1 + 1 + 73 + 1 + 1 + 1 + 139
 467                                 },
 468                                 // number_of_witness_elements + sig_length + revocation_sig + true_length + op_true + witness_script_length + witness_script
 469                                 &InputDescriptors::RevokedOutput => {
 470                                         1 + 1 + 73 + 1 + 1 + 1 + 77
 471                                 },
 472                         };
 473                 }
 474                 tx_weight
 475         }
 476
 477         /// In LN, output claimed are time-sensitive, which means we have to spend them before reaching some timelock expiration. At in-channel
 478         /// output detection, we generate a first version of a claim tx and associate to it a height timer. A height timer is an absolute block
 479         /// height than once reached we should generate a new bumped "version" of the claim tx to be sure than we safely claim outputs before
 480         /// than our counterparty can do it too. If timelock expires soon, height timer is going to be scale down in consequence to increase
 481         /// frequency of the bump and so increase our bets of success.
 482         fn get_height_timer(current_height: u32, timelock_expiration: u32) -> u32 {
 483                 if timelock_expiration <= current_height + 3 {
 484                         return current_height + 1
 485                 } else if timelock_expiration - current_height <= 15 {
 486                         return current_height + 3
 487                 }
 488                 current_height + 15
 489         }
 490
 491         /// Lightning security model (i.e being able to redeem/timeout HTLC or penalize coutnerparty onchain) lays on the assumption of claim transactions getting confirmed before timelock expiration
 492         /// (CSV or CLTV following cases). In case of high-fee spikes, claim tx may stuck in the mempool, so you need to bump its feerate quickly using Replace-By-Fee or Child-Pay-For-Parent.
 493         /// Panics if there are signing errors, because signing operations in reaction to on-chain events
 494         /// are not expected to fail, and if they do, we may lose funds.
 495         fn generate_claim_tx<F: Deref, L: Deref>(&mut self, height: u32, cached_claim_datas: &ClaimTxBumpMaterial, fee_estimator: &F, logger: &L) -> Option<(Option<u32>, u32, Transaction)>
 496                 where F::Target: FeeEstimator,
 497                                         L::Target: Logger,
 498         {
 499                 if cached_claim_datas.per_input_material.len() == 0 { return None } // But don't prune pending claiming request yet, we may have to resurrect HTLCs
 500                 let mut inputs = Vec::new();
 501                 for outp in cached_claim_datas.per_input_material.keys() {
 502                         log_trace!(logger, "Outpoint {}:{}", outp.txid, outp.vout);
 503                         inputs.push(TxIn {
 504                                 previous_output: *outp,
 505                                 script_sig: Script::new(),
 506                                 sequence: 0xfffffffd,
 507                                 witness: Vec::new(),
 508                         });
 509                 }
 510                 let mut bumped_tx = Transaction {
 511                         version: 2,
 512                         lock_time: 0,
 513                         input: inputs,
 514                         output: vec![TxOut {
 515                                 script_pubkey: self.destination_script.clone(),
 516                                 value: 0
 517                         }],
 518                 };
 519
 520                 macro_rules! RBF_bump {
 521                         ($amount: expr, $old_feerate: expr, $fee_estimator: expr, $predicted_weight: expr) => {
 522                                 {
 523                                         let mut used_feerate: u32;
 524                                         // If old feerate inferior to actual one given back by Fee Estimator, use it to compute new fee...
 525                                         let new_fee = if $old_feerate < $fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) {
 526                                                 let mut value = $amount;
 527                                                 if subtract_high_prio_fee!(logger, $fee_estimator, value, $predicted_weight, used_feerate) {
 528                                                         // Overflow check is done in subtract_high_prio_fee
 529                                                         ($amount - value)
 530                                                 } else {
 531                                                         log_trace!(logger, "Can't new-estimation bump new claiming tx, amount {} is too small", $amount);
 532                                                         return None;
 533                                                 }
 534                                         // ...else just increase the previous feerate by 25% (because that's a nice number)
 535                                         } else {
 536                                                 let fee = $old_feerate as u64 * ($predicted_weight as u64) / 750;
 537                                                 if $amount <= fee {
 538                                                         log_trace!(logger, "Can't 25% bump new claiming tx, amount {} is too small", $amount);
 539                                                         return None;
 540                                                 }
 541                                                 fee
 542                                         };
 543
 544                                         let previous_fee = $old_feerate as u64 * ($predicted_weight as u64) / 1000;
 545                                         let min_relay_fee = MIN_RELAY_FEE_SAT_PER_1000_WEIGHT * ($predicted_weight as u64) / 1000;
 546                                         // BIP 125 Opt-in Full Replace-by-Fee Signaling
 547                                         //      * 3. The replacement transaction pays an absolute fee of at least the sum paid by the original transactions.
 548                                         //      * 4. The replacement transaction must also pay for its own bandwidth at or above the rate set by the node's minimum relay fee setting.
 549                                         let new_fee = if new_fee < previous_fee + min_relay_fee {
 550                                                 new_fee + previous_fee + min_relay_fee - new_fee
 551                                         } else {
 552                                                 new_fee
 553                                         };
 554                                         Some((new_fee, new_fee * 1000 / ($predicted_weight as u64)))
 555                                 }
 556                         }
 557                 }
 558
 559                 // Compute new height timer to decide when we need to regenerate a new bumped version of the claim tx (if we
 560                 // didn't receive confirmation of it before, or not enough reorg-safe depth on top of it).
 561                 let new_timer = Some(Self::get_height_timer(height, cached_claim_datas.soonest_timelock));
 562                 let mut inputs_witnesses_weight = 0;
 563                 let mut amt = 0;
 564                 let mut dynamic_fee = true;
 565                 for per_outp_material in cached_claim_datas.per_input_material.values() {
 566                         match per_outp_material {
 567                                 &InputMaterial::Revoked { ref input_descriptor, ref amount, .. } => {
 568                                         inputs_witnesses_weight += Self::get_witnesses_weight(&[*input_descriptor]);
 569                                         amt += *amount;
 570                                 },
 571                                 &InputMaterial::CounterpartyHTLC { ref preimage, ref htlc, .. } => {
 572                                         inputs_witnesses_weight += Self::get_witnesses_weight(if preimage.is_some() { &[InputDescriptors::OfferedHTLC] } else { &[InputDescriptors::ReceivedHTLC] });
 573                                         amt += htlc.amount_msat / 1000;
 574                                 },
 575                                 &InputMaterial::HolderHTLC { .. } => {
 576                                         dynamic_fee = false;
 577                                 },
 578                                 &InputMaterial::Funding { .. } => {
 579                                         dynamic_fee = false;
 580                                 }
 581                         }
 582                 }
 583                 if dynamic_fee {
 584                         let predicted_weight = (bumped_tx.get_weight() + inputs_witnesses_weight) as u64;
 585                         let mut new_feerate;
 586                         // If old feerate is 0, first iteration of this claim, use normal fee calculation
 587                         if cached_claim_datas.feerate_previous != 0 {
 588                                 if let Some((new_fee, feerate)) = RBF_bump!(amt, cached_claim_datas.feerate_previous, fee_estimator, predicted_weight) {
 589                                         // If new computed fee is superior at the whole claimable amount burn all in fees
 590                                         if new_fee as u64 > amt {
 591                                                 bumped_tx.output[0].value = 0;
 592                                         } else {
 593                                                 bumped_tx.output[0].value = amt - new_fee as u64;
 594                                         }
 595                                         new_feerate = feerate;
 596                                 } else { return None; }
 597                         } else {
 598                                 if subtract_high_prio_fee!(logger, fee_estimator, amt, predicted_weight, new_feerate) {
 599                                         bumped_tx.output[0].value = amt;
 600                                 } else { return None; }
 601                         }
 602                         assert!(new_feerate != 0);
 603
 604                         for (i, (outp, per_outp_material)) in cached_claim_datas.per_input_material.iter().enumerate() {
 605                                 match per_outp_material {
 606                                         &InputMaterial::Revoked { ref per_commitment_point, ref counterparty_delayed_payment_base_key, ref counterparty_htlc_base_key, ref per_commitment_key, ref input_descriptor, ref amount, ref htlc, ref on_counterparty_tx_csv } => {
 607                                                 if let Ok(chan_keys) = TxCreationKeys::derive_new(&self.secp_ctx, &per_commitment_point, counterparty_delayed_payment_base_key, counterparty_htlc_base_key, &self.key_storage.pubkeys().revocation_basepoint, &self.key_storage.pubkeys().htlc_basepoint) {
 608
 609                                                         let witness_script = if let Some(ref htlc) = *htlc {
 610                                                                 chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, &chan_keys.broadcaster_htlc_key, &chan_keys.countersignatory_htlc_key, &chan_keys.revocation_key)
 611                                                         } else {
 612                                                                 chan_utils::get_revokeable_redeemscript(&chan_keys.revocation_key, *on_counterparty_tx_csv, &chan_keys.broadcaster_delayed_payment_key)
 613                                                         };
 614
 615                                                         if let Ok(sig) = self.key_storage.sign_justice_transaction(&bumped_tx, i, *amount, &per_commitment_key, htlc, &self.secp_ctx) {
 616                                                                 bumped_tx.input[i].witness.push(sig.serialize_der().to_vec());
 617                                                                 bumped_tx.input[i].witness[0].push(SigHashType::All as u8);
 618                                                                 if htlc.is_some() {
 619                                                                         bumped_tx.input[i].witness.push(chan_keys.revocation_key.clone().serialize().to_vec());
 620                                                                 } else {
 621                                                                         bumped_tx.input[i].witness.push(vec!(1));
 622                                                                 }
 623                                                                 bumped_tx.input[i].witness.push(witness_script.clone().into_bytes());
 624                                                         } else { return None; }
 625                                                         //TODO: panic ?
 626
 627                                                         log_trace!(logger, "Going to broadcast Penalty Transaction {} claiming revoked {} output {} from {} with new feerate {}...", bumped_tx.txid(), if *input_descriptor == InputDescriptors::RevokedOutput { "to_holder" } else if *input_descriptor == InputDescriptors::RevokedOfferedHTLC { "offered" } else if *input_descriptor == InputDescriptors::RevokedReceivedHTLC { "received" } else { "" }, outp.vout, outp.txid, new_feerate);
 628                                                 }
 629                                         },
 630                                         &InputMaterial::CounterpartyHTLC { ref per_commitment_point, ref counterparty_delayed_payment_base_key, ref counterparty_htlc_base_key, ref preimage, ref htlc } => {
 631                                                 if let Ok(chan_keys) = TxCreationKeys::derive_new(&self.secp_ctx, &per_commitment_point, counterparty_delayed_payment_base_key, counterparty_htlc_base_key, &self.key_storage.pubkeys().revocation_basepoint, &self.key_storage.pubkeys().htlc_basepoint) {
 632                                                         let witness_script = chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, &chan_keys.broadcaster_htlc_key, &chan_keys.countersignatory_htlc_key, &chan_keys.revocation_key);
 633
 634                                                         if !preimage.is_some() { bumped_tx.lock_time = htlc.cltv_expiry }; // Right now we don't aggregate time-locked transaction, if we do we should set lock_time before to avoid breaking hash computation
 635                                                         if let Ok(sig) = self.key_storage.sign_counterparty_htlc_transaction(&bumped_tx, i, &htlc.amount_msat / 1000, &per_commitment_point, htlc, &self.secp_ctx) {
 636                                                                 bumped_tx.input[i].witness.push(sig.serialize_der().to_vec());
 637                                                                 bumped_tx.input[i].witness[0].push(SigHashType::All as u8);
 638                                                                 if let &Some(preimage) = preimage {
 639                                                                         bumped_tx.input[i].witness.push(preimage.0.to_vec());
 640                                                                 } else {
 641                                                                         // Due to BIP146 (MINIMALIF) this must be a zero-length element to relay.
 642                                                                         bumped_tx.input[i].witness.push(vec![]);
 643                                                                 }
 644                                                                 bumped_tx.input[i].witness.push(witness_script.clone().into_bytes());
 645                                                         }
 646                                                         log_trace!(logger, "Going to broadcast Claim Transaction {} claiming counterparty {} htlc output {} from {} with new feerate {}...", bumped_tx.txid(), if preimage.is_some() { "offered" } else { "received" }, outp.vout, outp.txid, new_feerate);
 647                                                 }
 648                                         },
 649                                         _ => unreachable!()
 650                                 }
 651                         }
 652                         log_trace!(logger, "...with timer {}", new_timer.unwrap());
 653                         assert!(predicted_weight >= bumped_tx.get_weight() as u64);
 654                         return Some((new_timer, new_feerate as u32, bumped_tx))
 655                 } else {
 656                         for (_, (outp, per_outp_material)) in cached_claim_datas.per_input_material.iter().enumerate() {
 657                                 match per_outp_material {
 658                                         &InputMaterial::HolderHTLC { ref preimage, ref amount } => {
 659                                                 let htlc_tx = self.get_fully_signed_htlc_tx(outp, preimage);
 660                                                 if let Some(htlc_tx) = htlc_tx {
 661                                                         let feerate = (amount - htlc_tx.output[0].value) * 1000 / htlc_tx.get_weight() as u64;
 662                                                         // Timer set to $NEVER given we can't bump tx without anchor outputs
 663                                                         log_trace!(logger, "Going to broadcast Holder HTLC-{} claiming HTLC output {} from {}...", if preimage.is_some() { "Success" } else { "Timeout" }, outp.vout, outp.txid);
 664                                                         return Some((None, feerate as u32, htlc_tx));
 665                                                 }
 666                                                 return None;
 667                                         },
 668                                         &InputMaterial::Funding { ref funding_redeemscript } => {
 669                                                 let signed_tx = self.get_fully_signed_holder_tx(funding_redeemscript).unwrap();
 670                                                 // Timer set to $NEVER given we can't bump tx without anchor outputs
 671                                                 log_trace!(logger, "Going to broadcast Holder Transaction {} claiming funding output {} from {}...", signed_tx.txid(), outp.vout, outp.txid);
 672                                                 return Some((None, self.holder_commitment.as_ref().unwrap().feerate_per_kw(), signed_tx));
 673                                         }
 674                                         _ => unreachable!()
 675                                 }
 676                         }
 677                 }
 678                 None
 679         }
 680
 681         /// Upon channelmonitor.block_connected(..) or upon provision of a preimage on the forward link
 682         /// for this channel, provide new relevant on-chain transactions and/or new claim requests.
 683         /// Formerly this was named `block_connected`, but it is now also used for claiming an HTLC output
 684         /// if we receive a preimage after force-close.
 685         pub(crate) fn update_claims_view<B: Deref, F: Deref, L: Deref>(&mut self, txn_matched: &[&Transaction], claimable_outpoints: Vec<ClaimRequest>, latest_height: Option<u32>, broadcaster: &B, fee_estimator: &F, logger: &L)
 686                 where B::Target: BroadcasterInterface,
 687                       F::Target: FeeEstimator,
 688                                         L::Target: Logger,
 689         {
 690                 let height = match latest_height {
 691                         Some(h) => h,
 692                         None => self.latest_height,
 693                 };
 694                 log_trace!(logger, "Updating claims view at height {} with {} matched transactions and {} claim requests", height, txn_matched.len(), claimable_outpoints.len());
 695                 let mut new_claims = Vec::new();
 696                 let mut aggregated_claim = HashMap::new();
 697                 let mut aggregated_soonest = ::std::u32::MAX;
 698
 699                 // Try to aggregate outputs if their timelock expiration isn't imminent (absolute_timelock
 700                 // <= CLTV_SHARED_CLAIM_BUFFER) and they don't require an immediate nLockTime (aggregable).
 701                 for req in claimable_outpoints {
 702                         // Don't claim a outpoint twice that would be bad for privacy and may uselessly lock a CPFP input for a while
 703                         if let Some(_) = self.claimable_outpoints.get(&req.outpoint) { log_trace!(logger, "Bouncing off outpoint {}:{}, already registered its claiming request", req.outpoint.txid, req.outpoint.vout); } else {
 704                                 log_trace!(logger, "Test if outpoint can be aggregated with expiration {} against {}", req.absolute_timelock, height + CLTV_SHARED_CLAIM_BUFFER);
 705                                 if req.absolute_timelock <= height + CLTV_SHARED_CLAIM_BUFFER || !req.aggregable { // Don't aggregate if outpoint absolute timelock is soon or marked as non-aggregable
 706                                         let mut single_input = HashMap::new();
 707                                         single_input.insert(req.outpoint, req.witness_data);
 708                                         new_claims.push((req.absolute_timelock, single_input));
 709                                 } else {
 710                                         aggregated_claim.insert(req.outpoint, req.witness_data);
 711                                         if req.absolute_timelock < aggregated_soonest {
 712                                                 aggregated_soonest = req.absolute_timelock;
 713                                         }
 714                                 }
 715                         }
 716                 }
 717                 new_claims.push((aggregated_soonest, aggregated_claim));
 718
 719                 // Generate claim transactions and track them to bump if necessary at
 720                 // height timer expiration (i.e in how many blocks we're going to take action).
 721                 for (soonest_timelock, claim) in new_claims.drain(..) {
 722                         let mut claim_material = ClaimTxBumpMaterial { height_timer: None, feerate_previous: 0, soonest_timelock, per_input_material: claim };
 723                         if let Some((new_timer, new_feerate, tx)) = self.generate_claim_tx(height, &claim_material, &*fee_estimator, &*logger) {
 724                                 claim_material.height_timer = new_timer;
 725                                 claim_material.feerate_previous = new_feerate;
 726                                 let txid = tx.txid();
 727                                 for k in claim_material.per_input_material.keys() {
 728                                         log_trace!(logger, "Registering claiming request for {}:{}", k.txid, k.vout);
 729                                         self.claimable_outpoints.insert(k.clone(), (txid, height));
 730                                 }
 731                                 self.pending_claim_requests.insert(txid, claim_material);
 732                                 log_trace!(logger, "Broadcast onchain {}", log_tx!(tx));
 733                                 broadcaster.broadcast_transaction(&tx);
 734                         }
 735                 }
 736
 737                 let mut bump_candidates = HashMap::new();
 738                 for tx in txn_matched {
 739                         // Scan all input to verify is one of the outpoint spent is of interest for us
 740                         let mut claimed_outputs_material = Vec::new();
 741                         for inp in &tx.input {
 742                                 if let Some(first_claim_txid_height) = self.claimable_outpoints.get(&inp.previous_output) {
 743                                         // If outpoint has claim request pending on it...
 744                                         if let Some(claim_material) = self.pending_claim_requests.get_mut(&first_claim_txid_height.0) {
 745                                                 //... we need to verify equality between transaction outpoints and claim request
 746                                                 // outpoints to know if transaction is the original claim or a bumped one issued
 747                                                 // by us.
 748                                                 let mut set_equality = true;
 749                                                 if claim_material.per_input_material.len() != tx.input.len() {
 750                                                         set_equality = false;
 751                                                 } else {
 752                                                         for (claim_inp, tx_inp) in claim_material.per_input_material.keys().zip(tx.input.iter()) {
 753                                                                 if *claim_inp != tx_inp.previous_output {
 754                                                                         set_equality = false;
 755                                                                 }
 756                                                         }
 757                                                 }
 758
 759                                                 macro_rules! clean_claim_request_after_safety_delay {
 760                                                         () => {
 761                                                                 let new_event = OnchainEvent::Claim { claim_request: first_claim_txid_height.0.clone() };
 762                                                                 match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
 763                                                                         hash_map::Entry::Occupied(mut entry) => {
 764                                                                                 if !entry.get().contains(&new_event) {
 765                                                                                         entry.get_mut().push(new_event);
 766                                                                                 }
 767                                                                         },
 768                                                                         hash_map::Entry::Vacant(entry) => {
 769                                                                                 entry.insert(vec![new_event]);
 770                                                                         }
 771                                                                 }
 772                                                         }
 773                                                 }
 774
 775                                                 // If this is our transaction (or our counterparty spent all the outputs
 776                                                 // before we could anyway with same inputs order than us), wait for
 777                                                 // ANTI_REORG_DELAY and clean the RBF tracking map.
 778                                                 if set_equality {
 779                                                         clean_claim_request_after_safety_delay!();
 780                                                 } else { // If false, generate new claim request with update outpoint set
 781                                                         let mut at_least_one_drop = false;
 782                                                         for input in tx.input.iter() {
 783                                                                 if let Some(input_material) = claim_material.per_input_material.remove(&input.previous_output) {
 784                                                                         claimed_outputs_material.push((input.previous_output, input_material));
 785                                                                         at_least_one_drop = true;
 786                                                                 }
 787                                                                 // If there are no outpoints left to claim in this request, drop it entirely after ANTI_REORG_DELAY.
 788                                                                 if claim_material.per_input_material.is_empty() {
 789                                                                         clean_claim_request_after_safety_delay!();
 790                                                                 }
 791                                                         }
 792                                                         //TODO: recompute soonest_timelock to avoid wasting a bit on fees
 793                                                         if at_least_one_drop {
 794                                                                 bump_candidates.insert(first_claim_txid_height.0.clone(), claim_material.clone());
 795                                                         }
 796                                                 }
 797                                                 break; //No need to iterate further, either tx is our or their
 798                                         } else {
 799                                                 panic!("Inconsistencies between pending_claim_requests map and claimable_outpoints map");
 800                                         }
 801                                 }
 802                         }
 803                         for (outpoint, input_material) in claimed_outputs_material.drain(..) {
 804                                 let new_event = OnchainEvent::ContentiousOutpoint { outpoint, input_material };
 805                                 match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
 806                                         hash_map::Entry::Occupied(mut entry) => {
 807                                                 if !entry.get().contains(&new_event) {
 808                                                         entry.get_mut().push(new_event);
 809                                                 }
 810                                         },
 811                                         hash_map::Entry::Vacant(entry) => {
 812                                                 entry.insert(vec![new_event]);
 813                                         }
 814                                 }
 815                         }
 816                 }
 817
 818                 // After security delay, either our claim tx got enough confs or outpoint is definetely out of reach
 819                 if let Some(events) = self.onchain_events_waiting_threshold_conf.remove(&height) {
 820                         for ev in events {
 821                                 match ev {
 822                                         OnchainEvent::Claim { claim_request } => {
 823                                                 // We may remove a whole set of claim outpoints here, as these one may have
 824                                                 // been aggregated in a single tx and claimed so atomically
 825                                                 if let Some(bump_material) = self.pending_claim_requests.remove(&claim_request) {
 826                                                         for outpoint in bump_material.per_input_material.keys() {
 827                                                                 self.claimable_outpoints.remove(&outpoint);
 828                                                         }
 829                                                 }
 830                                         },
 831                                         OnchainEvent::ContentiousOutpoint { outpoint, .. } => {
 832                                                 self.claimable_outpoints.remove(&outpoint);
 833                                         }
 834                                 }
 835                         }
 836                 }
 837
 838                 // Check if any pending claim request must be rescheduled
 839                 for (first_claim_txid, ref claim_data) in self.pending_claim_requests.iter() {
 840                         if let Some(h) = claim_data.height_timer {
 841                                 if h == height {
 842                                         bump_candidates.insert(*first_claim_txid, (*claim_data).clone());
 843                                 }
 844                         }
 845                 }
 846
 847                 // Build, bump and rebroadcast tx accordingly
 848                 log_trace!(logger, "Bumping {} candidates", bump_candidates.len());
 849                 for (first_claim_txid, claim_material) in bump_candidates.iter() {
 850                         if let Some((new_timer, new_feerate, bump_tx)) = self.generate_claim_tx(height, &claim_material, &*fee_estimator, &*logger) {
 851                                 log_trace!(logger, "Broadcast onchain {}", log_tx!(bump_tx));
 852                                 broadcaster.broadcast_transaction(&bump_tx);
 853                                 if let Some(claim_material) = self.pending_claim_requests.get_mut(first_claim_txid) {
 854                                         claim_material.height_timer = new_timer;
 855                                         claim_material.feerate_previous = new_feerate;
 856                                 }
 857                         }
 858                 }
 859         }
 860
 861         pub(crate) fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, height: u32, broadcaster: B, fee_estimator: F, logger: L)
 862                 where B::Target: BroadcasterInterface,
 863                       F::Target: FeeEstimator,
 864                                         L::Target: Logger,
 865         {
 866                 let mut bump_candidates = HashMap::new();
 867                 if let Some(events) = self.onchain_events_waiting_threshold_conf.remove(&(height + ANTI_REORG_DELAY - 1)) {
 868                         //- our claim tx on a commitment tx output
 869                         //- resurect outpoint back in its claimable set and regenerate tx
 870                         for ev in events {
 871                                 match ev {
 872                                         OnchainEvent::ContentiousOutpoint { outpoint, input_material } => {
 873                                                 if let Some(ancestor_claimable_txid) = self.claimable_outpoints.get(&outpoint) {
 874                                                         if let Some(claim_material) = self.pending_claim_requests.get_mut(&ancestor_claimable_txid.0) {
 875                                                                 claim_material.per_input_material.insert(outpoint, input_material);
 876                                                                 // Using a HashMap guarantee us than if we have multiple outpoints getting
 877                                                                 // resurrected only one bump claim tx is going to be broadcast
 878                                                                 bump_candidates.insert(ancestor_claimable_txid.clone(), claim_material.clone());
 879                                                         }
 880                                                 }
 881                                         },
 882                                         _ => {},
 883                                 }
 884                         }
 885                 }
 886                 for (_, claim_material) in bump_candidates.iter_mut() {
 887                         if let Some((new_timer, new_feerate, bump_tx)) = self.generate_claim_tx(height, &claim_material, &&*fee_estimator, &&*logger) {
 888                                 claim_material.height_timer = new_timer;
 889                                 claim_material.feerate_previous = new_feerate;
 890                                 broadcaster.broadcast_transaction(&bump_tx);
 891                         }
 892                 }
 893                 for (ancestor_claim_txid, claim_material) in bump_candidates.drain() {
 894                         self.pending_claim_requests.insert(ancestor_claim_txid.0, claim_material);
 895                 }
 896                 //TODO: if we implement cross-block aggregated claim transaction we need to refresh set of outpoints and regenerate tx but
 897                 // right now if one of the outpoint get disconnected, just erase whole pending claim request.
 898                 let mut remove_request = Vec::new();
 899                 self.claimable_outpoints.retain(|_, ref v|
 900                         if v.1 == height {
 901                         remove_request.push(v.0.clone());
 902                         false
 903                         } else { true });
 904                 for req in remove_request {
 905                         self.pending_claim_requests.remove(&req);
 906                 }
 907         }
 908
 909         pub(crate) fn provide_latest_holder_tx(&mut self, tx: HolderCommitmentTransaction) {
 910                 self.prev_holder_commitment = self.holder_commitment.take();
 911                 self.holder_htlc_sigs = None;
 912                 self.holder_commitment = Some(tx);
 913         }
 914
 915         // Normally holder HTLCs are signed at the same time as the holder commitment tx.  However,
 916         // in some configurations, the holder commitment tx has been signed and broadcast by a
 917         // ChannelMonitor replica, so we handle that case here.
 918         fn sign_latest_holder_htlcs(&mut self) {
 919                 if self.holder_htlc_sigs.is_none() {
 920                         if let Some(ref holder_commitment) = self.holder_commitment {
 921                                 let (_sig, sigs) = self.key_storage.sign_holder_commitment_and_htlcs(holder_commitment, &self.secp_ctx).expect("sign holder commitment");
 922                                 self.holder_htlc_sigs = Some(Self::extract_holder_sigs(holder_commitment, sigs));
 923                         }
 924                 }
 925         }
 926
 927         // Normally only the latest commitment tx and HTLCs need to be signed.  However, in some
 928         // configurations we may have updated our holder commtiment but a replica of the ChannelMonitor
 929         // broadcast the previous one before we sync with it.  We handle that case here.
 930         fn sign_prev_holder_htlcs(&mut self) {
 931                 if self.prev_holder_htlc_sigs.is_none() {
 932                         if let Some(ref holder_commitment) = self.prev_holder_commitment {
 933                                 let (_sig, sigs) = self.key_storage.sign_holder_commitment_and_htlcs(holder_commitment, &self.secp_ctx).expect("sign previous holder commitment");
 934                                 self.prev_holder_htlc_sigs = Some(Self::extract_holder_sigs(holder_commitment, sigs));
 935                         }
 936                 }
 937         }
 938
 939         fn extract_holder_sigs(holder_commitment: &HolderCommitmentTransaction, sigs: Vec<Signature>) -> Vec<Option<(usize, Signature)>> {
 940                 let mut ret = Vec::new();
 941                 for (htlc_idx, (holder_sig, htlc)) in sigs.iter().zip(holder_commitment.htlcs().iter()).enumerate() {
 942                         let tx_idx = htlc.transaction_output_index.unwrap();
 943                         if ret.len() <= tx_idx as usize { ret.resize(tx_idx as usize + 1, None); }
 944                         ret[tx_idx as usize] = Some((htlc_idx, holder_sig.clone()));
 945                 }
 946                 ret
 947         }
 948
 949         //TODO: getting lastest holder transactions should be infallible and result in us "force-closing the channel", but we may
 950         // have empty holder commitment transaction if a ChannelMonitor is asked to force-close just after Channel::get_outbound_funding_created,
 951         // before providing a initial commitment transaction. For outbound channel, init ChannelMonitor at Channel::funding_signed, there is nothing
 952         // to monitor before.
 953         pub(crate) fn get_fully_signed_holder_tx(&mut self, funding_redeemscript: &Script) -> Option<Transaction> {
 954                 if let Some(ref mut holder_commitment) = self.holder_commitment {
 955                         match self.key_storage.sign_holder_commitment_and_htlcs(holder_commitment, &self.secp_ctx) {
 956                                 Ok((sig, htlc_sigs)) => {
 957                                         self.holder_htlc_sigs = Some(Self::extract_holder_sigs(holder_commitment, htlc_sigs));
 958                                         Some(holder_commitment.add_holder_sig(funding_redeemscript, sig))
 959                                 },
 960                                 Err(_) => return None,
 961                         }
 962                 } else {
 963                         None
 964                 }
 965         }
 966
 967         #[cfg(any(test, feature="unsafe_revoked_tx_signing"))]
 968         pub(crate) fn get_fully_signed_copy_holder_tx(&mut self, funding_redeemscript: &Script) -> Option<Transaction> {
 969                 if let Some(ref mut holder_commitment) = self.holder_commitment {
 970                         match self.key_storage.sign_holder_commitment_and_htlcs(holder_commitment, &self.secp_ctx) {
 971                                 Ok((sig, htlc_sigs)) => {
 972                                         self.holder_htlc_sigs = Some(Self::extract_holder_sigs(holder_commitment, htlc_sigs));
 973                                         Some(holder_commitment.add_holder_sig(funding_redeemscript, sig))
 974                                 },
 975                                 Err(_) => return None,
 976                         }
 977                 } else {
 978                         None
 979                 }
 980         }
 981
 982         pub(crate) fn get_fully_signed_htlc_tx(&mut self, outp: &::bitcoin::OutPoint, preimage: &Option<PaymentPreimage>) -> Option<Transaction> {
 983                 let mut htlc_tx = None;
 984                 if self.holder_commitment.is_some() {
 985                         let commitment_txid = self.holder_commitment.as_ref().unwrap().trust().txid();
 986                         if commitment_txid == outp.txid {
 987                                 self.sign_latest_holder_htlcs();
 988                                 if let &Some(ref htlc_sigs) = &self.holder_htlc_sigs {
 989                                         let &(ref htlc_idx, ref htlc_sig) = htlc_sigs[outp.vout as usize].as_ref().unwrap();
 990                                         let holder_commitment = self.holder_commitment.as_ref().unwrap();
 991                                         let trusted_tx = holder_commitment.trust();
 992                                         let counterparty_htlc_sig = holder_commitment.counterparty_htlc_sigs[*htlc_idx];
 993                                         htlc_tx = Some(trusted_tx
 994                                                 .get_signed_htlc_tx(&self.channel_transaction_parameters.as_holder_broadcastable(), *htlc_idx, &counterparty_htlc_sig, htlc_sig, preimage));
 995                                 }
 996                         }
 997                 }
 998                 if htlc_tx.is_none() && self.prev_holder_commitment.is_some() {
 999                         let commitment_txid = self.prev_holder_commitment.as_ref().unwrap().trust().txid();
1000                         if commitment_txid == outp.txid {
1001                                 self.sign_prev_holder_htlcs();
1002                                 if let &Some(ref htlc_sigs) = &self.prev_holder_htlc_sigs {
1003                                         let &(ref htlc_idx, ref htlc_sig) = htlc_sigs[outp.vout as usize].as_ref().unwrap();
1004                                         let holder_commitment = self.prev_holder_commitment.as_ref().unwrap();
1005                                         let trusted_tx = holder_commitment.trust();
1006                                         let counterparty_htlc_sig = holder_commitment.counterparty_htlc_sigs[*htlc_idx];
1007                                         htlc_tx = Some(trusted_tx
1008                                                 .get_signed_htlc_tx(&self.channel_transaction_parameters.as_holder_broadcastable(), *htlc_idx, &counterparty_htlc_sig, htlc_sig, preimage));
1009                                 }
1010                         }
1011                 }
1012                 htlc_tx
1013         }
1014
1015         #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
1016         pub(crate) fn unsafe_get_fully_signed_htlc_tx(&mut self, outp: &::bitcoin::OutPoint, preimage: &Option<PaymentPreimage>) -> Option<Transaction> {
1017                 let latest_had_sigs = self.holder_htlc_sigs.is_some();
1018                 let prev_had_sigs = self.prev_holder_htlc_sigs.is_some();
1019                 let ret = self.get_fully_signed_htlc_tx(outp, preimage);
1020                 if !latest_had_sigs {
1021                         self.holder_htlc_sigs = None;
1022                 }
1023                 if !prev_had_sigs {
1024                         self.prev_holder_htlc_sigs = None;
1025                 }
1026                 ret
1027         }
1028 }