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