513e4a136dc742dc9d5f2ad8268271658d7ff511
[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::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;
31 use util::logger::Logger;
32 use util::ser::{Readable, Writer, Writeable};
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.key_storage.write(writer)?;
298                 self.channel_transaction_parameters.write(writer)?;
299
300                 writer.write_all(&byte_utils::be64_to_array(self.pending_claim_requests.len() as u64))?;
301                 for (ref ancestor_claim_txid, claim_tx_data) in self.pending_claim_requests.iter() {
302                         ancestor_claim_txid.write(writer)?;
303                         claim_tx_data.write(writer)?;
304                 }
305
306                 writer.write_all(&byte_utils::be64_to_array(self.claimable_outpoints.len() as u64))?;
307                 for (ref outp, ref claim_and_height) in self.claimable_outpoints.iter() {
308                         outp.write(writer)?;
309                         claim_and_height.0.write(writer)?;
310                         claim_and_height.1.write(writer)?;
311                 }
312
313                 writer.write_all(&byte_utils::be64_to_array(self.onchain_events_waiting_threshold_conf.len() as u64))?;
314                 for (ref target, ref events) in self.onchain_events_waiting_threshold_conf.iter() {
315                         writer.write_all(&byte_utils::be32_to_array(**target))?;
316                         writer.write_all(&byte_utils::be64_to_array(events.len() as u64))?;
317                         for ev in events.iter() {
318                                 match *ev {
319                                         OnchainEvent::Claim { ref claim_request } => {
320                                                 writer.write_all(&[0; 1])?;
321                                                 claim_request.write(writer)?;
322                                         },
323                                         OnchainEvent::ContentiousOutpoint { ref outpoint, ref input_material } => {
324                                                 writer.write_all(&[1; 1])?;
325                                                 outpoint.write(writer)?;
326                                                 input_material.write(writer)?;
327                                         }
328                                 }
329                         }
330                 }
331                 self.latest_height.write(writer)?;
332                 Ok(())
333         }
334 }
335
336 impl<ChanSigner: ChannelKeys + Readable> Readable for OnchainTxHandler<ChanSigner> {
337         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
338                 let destination_script = Readable::read(reader)?;
339
340                 let holder_commitment = Readable::read(reader)?;
341                 let holder_htlc_sigs = Readable::read(reader)?;
342                 let prev_holder_commitment = Readable::read(reader)?;
343                 let prev_holder_htlc_sigs = Readable::read(reader)?;
344
345                 let key_storage = Readable::read(reader)?;
346                 let channel_parameters = Readable::read(reader)?;
347
348                 let pending_claim_requests_len: u64 = Readable::read(reader)?;
349                 let mut pending_claim_requests = HashMap::with_capacity(cmp::min(pending_claim_requests_len as usize, MAX_ALLOC_SIZE / 128));
350                 for _ in 0..pending_claim_requests_len {
351                         pending_claim_requests.insert(Readable::read(reader)?, Readable::read(reader)?);
352                 }
353
354                 let claimable_outpoints_len: u64 = Readable::read(reader)?;
355                 let mut claimable_outpoints = HashMap::with_capacity(cmp::min(pending_claim_requests_len as usize, MAX_ALLOC_SIZE / 128));
356                 for _ in 0..claimable_outpoints_len {
357                         let outpoint = Readable::read(reader)?;
358                         let ancestor_claim_txid = Readable::read(reader)?;
359                         let height = Readable::read(reader)?;
360                         claimable_outpoints.insert(outpoint, (ancestor_claim_txid, height));
361                 }
362                 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
363                 let mut onchain_events_waiting_threshold_conf = HashMap::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
364                 for _ in 0..waiting_threshold_conf_len {
365                         let height_target = Readable::read(reader)?;
366                         let events_len: u64 = Readable::read(reader)?;
367                         let mut events = Vec::with_capacity(cmp::min(events_len as usize, MAX_ALLOC_SIZE / 128));
368                         for _ in 0..events_len {
369                                 let ev = match <u8 as Readable>::read(reader)? {
370                                         0 => {
371                                                 let claim_request = Readable::read(reader)?;
372                                                 OnchainEvent::Claim {
373                                                         claim_request
374                                                 }
375                                         },
376                                         1 => {
377                                                 let outpoint = Readable::read(reader)?;
378                                                 let input_material = Readable::read(reader)?;
379                                                 OnchainEvent::ContentiousOutpoint {
380                                                         outpoint,
381                                                         input_material
382                                                 }
383                                         }
384                                         _ => return Err(DecodeError::InvalidValue),
385                                 };
386                                 events.push(ev);
387                         }
388                         onchain_events_waiting_threshold_conf.insert(height_target, events);
389                 }
390                 let latest_height = Readable::read(reader)?;
391
392                 Ok(OnchainTxHandler {
393                         destination_script,
394                         holder_commitment,
395                         holder_htlc_sigs,
396                         prev_holder_commitment,
397                         prev_holder_htlc_sigs,
398                         key_storage,
399                         channel_transaction_parameters: channel_parameters,
400                         claimable_outpoints,
401                         pending_claim_requests,
402                         onchain_events_waiting_threshold_conf,
403                         latest_height,
404                         secp_ctx: Secp256k1::new(),
405                 })
406         }
407 }
408
409 impl<ChanSigner: ChannelKeys> OnchainTxHandler<ChanSigner> {
410         pub(crate) fn new(destination_script: Script, keys: ChanSigner, channel_parameters: ChannelTransactionParameters) -> Self {
411
412                 let key_storage = keys;
413
414                 OnchainTxHandler {
415                         destination_script,
416                         holder_commitment: None,
417                         holder_htlc_sigs: None,
418                         prev_holder_commitment: None,
419                         prev_holder_htlc_sigs: None,
420                         key_storage,
421                         channel_transaction_parameters: channel_parameters,
422                         pending_claim_requests: HashMap::new(),
423                         claimable_outpoints: HashMap::new(),
424                         onchain_events_waiting_threshold_conf: HashMap::new(),
425                         latest_height: 0,
426
427                         secp_ctx: Secp256k1::new(),
428                 }
429         }
430
431         pub(crate) fn get_witnesses_weight(inputs: &[InputDescriptors]) -> usize {
432                 let mut tx_weight = 2; // count segwit flags
433                 for inp in inputs {
434                         // We use expected weight (and not actual) as signatures and time lock delays may vary
435                         tx_weight +=  match inp {
436                                 // number_of_witness_elements + sig_length + revocation_sig + pubkey_length + revocationpubkey + witness_script_length + witness_script
437                                 &InputDescriptors::RevokedOfferedHTLC => {
438                                         1 + 1 + 73 + 1 + 33 + 1 + 133
439                                 },
440                                 // number_of_witness_elements + sig_length + revocation_sig + pubkey_length + revocationpubkey + witness_script_length + witness_script
441                                 &InputDescriptors::RevokedReceivedHTLC => {
442                                         1 + 1 + 73 + 1 + 33 + 1 + 139
443                                 },
444                                 // number_of_witness_elements + sig_length + counterpartyhtlc_sig  + preimage_length + preimage + witness_script_length + witness_script
445                                 &InputDescriptors::OfferedHTLC => {
446                                         1 + 1 + 73 + 1 + 32 + 1 + 133
447                                 },
448                                 // number_of_witness_elements + sig_length + revocation_sig + pubkey_length + revocationpubkey + witness_script_length + witness_script
449                                 &InputDescriptors::ReceivedHTLC => {
450                                         1 + 1 + 73 + 1 + 1 + 1 + 139
451                                 },
452                                 // number_of_witness_elements + sig_length + revocation_sig + true_length + op_true + witness_script_length + witness_script
453                                 &InputDescriptors::RevokedOutput => {
454                                         1 + 1 + 73 + 1 + 1 + 1 + 77
455                                 },
456                         };
457                 }
458                 tx_weight
459         }
460
461         /// In LN, output claimed are time-sensitive, which means we have to spend them before reaching some timelock expiration. At in-channel
462         /// 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
463         /// height than once reached we should generate a new bumped "version" of the claim tx to be sure than we safely claim outputs before
464         /// than our counterparty can do it too. If timelock expires soon, height timer is going to be scale down in consequence to increase
465         /// frequency of the bump and so increase our bets of success.
466         fn get_height_timer(current_height: u32, timelock_expiration: u32) -> u32 {
467                 if timelock_expiration <= current_height + 3 {
468                         return current_height + 1
469                 } else if timelock_expiration - current_height <= 15 {
470                         return current_height + 3
471                 }
472                 current_height + 15
473         }
474
475         /// 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
476         /// (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.
477         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)>
478                 where F::Target: FeeEstimator,
479                                         L::Target: Logger,
480         {
481                 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
482                 let mut inputs = Vec::new();
483                 for outp in cached_claim_datas.per_input_material.keys() {
484                         log_trace!(logger, "Outpoint {}:{}", outp.txid, outp.vout);
485                         inputs.push(TxIn {
486                                 previous_output: *outp,
487                                 script_sig: Script::new(),
488                                 sequence: 0xfffffffd,
489                                 witness: Vec::new(),
490                         });
491                 }
492                 let mut bumped_tx = Transaction {
493                         version: 2,
494                         lock_time: 0,
495                         input: inputs,
496                         output: vec![TxOut {
497                                 script_pubkey: self.destination_script.clone(),
498                                 value: 0
499                         }],
500                 };
501
502                 macro_rules! RBF_bump {
503                         ($amount: expr, $old_feerate: expr, $fee_estimator: expr, $predicted_weight: expr) => {
504                                 {
505                                         let mut used_feerate: u32;
506                                         // If old feerate inferior to actual one given back by Fee Estimator, use it to compute new fee...
507                                         let new_fee = if $old_feerate < $fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) {
508                                                 let mut value = $amount;
509                                                 if subtract_high_prio_fee!(logger, $fee_estimator, value, $predicted_weight, used_feerate) {
510                                                         // Overflow check is done in subtract_high_prio_fee
511                                                         ($amount - value)
512                                                 } else {
513                                                         log_trace!(logger, "Can't new-estimation bump new claiming tx, amount {} is too small", $amount);
514                                                         return None;
515                                                 }
516                                         // ...else just increase the previous feerate by 25% (because that's a nice number)
517                                         } else {
518                                                 let fee = $old_feerate as u64 * ($predicted_weight as u64) / 750;
519                                                 if $amount <= fee {
520                                                         log_trace!(logger, "Can't 25% bump new claiming tx, amount {} is too small", $amount);
521                                                         return None;
522                                                 }
523                                                 fee
524                                         };
525
526                                         let previous_fee = $old_feerate as u64 * ($predicted_weight as u64) / 1000;
527                                         let min_relay_fee = MIN_RELAY_FEE_SAT_PER_1000_WEIGHT * ($predicted_weight as u64) / 1000;
528                                         // BIP 125 Opt-in Full Replace-by-Fee Signaling
529                                         //      * 3. The replacement transaction pays an absolute fee of at least the sum paid by the original transactions.
530                                         //      * 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.
531                                         let new_fee = if new_fee < previous_fee + min_relay_fee {
532                                                 new_fee + previous_fee + min_relay_fee - new_fee
533                                         } else {
534                                                 new_fee
535                                         };
536                                         Some((new_fee, new_fee * 1000 / ($predicted_weight as u64)))
537                                 }
538                         }
539                 }
540
541                 // Compute new height timer to decide when we need to regenerate a new bumped version of the claim tx (if we
542                 // didn't receive confirmation of it before, or not enough reorg-safe depth on top of it).
543                 let new_timer = Some(Self::get_height_timer(height, cached_claim_datas.soonest_timelock));
544                 let mut inputs_witnesses_weight = 0;
545                 let mut amt = 0;
546                 let mut dynamic_fee = true;
547                 for per_outp_material in cached_claim_datas.per_input_material.values() {
548                         match per_outp_material {
549                                 &InputMaterial::Revoked { ref input_descriptor, ref amount, .. } => {
550                                         inputs_witnesses_weight += Self::get_witnesses_weight(&[*input_descriptor]);
551                                         amt += *amount;
552                                 },
553                                 &InputMaterial::CounterpartyHTLC { ref preimage, ref htlc, .. } => {
554                                         inputs_witnesses_weight += Self::get_witnesses_weight(if preimage.is_some() { &[InputDescriptors::OfferedHTLC] } else { &[InputDescriptors::ReceivedHTLC] });
555                                         amt += htlc.amount_msat / 1000;
556                                 },
557                                 &InputMaterial::HolderHTLC { .. } => {
558                                         dynamic_fee = false;
559                                 },
560                                 &InputMaterial::Funding { .. } => {
561                                         dynamic_fee = false;
562                                 }
563                         }
564                 }
565                 if dynamic_fee {
566                         let predicted_weight = (bumped_tx.get_weight() + inputs_witnesses_weight) as u64;
567                         let mut new_feerate;
568                         // If old feerate is 0, first iteration of this claim, use normal fee calculation
569                         if cached_claim_datas.feerate_previous != 0 {
570                                 if let Some((new_fee, feerate)) = RBF_bump!(amt, cached_claim_datas.feerate_previous, fee_estimator, predicted_weight) {
571                                         // If new computed fee is superior at the whole claimable amount burn all in fees
572                                         if new_fee as u64 > amt {
573                                                 bumped_tx.output[0].value = 0;
574                                         } else {
575                                                 bumped_tx.output[0].value = amt - new_fee as u64;
576                                         }
577                                         new_feerate = feerate;
578                                 } else { return None; }
579                         } else {
580                                 if subtract_high_prio_fee!(logger, fee_estimator, amt, predicted_weight, new_feerate) {
581                                         bumped_tx.output[0].value = amt;
582                                 } else { return None; }
583                         }
584                         assert!(new_feerate != 0);
585
586                         for (i, (outp, per_outp_material)) in cached_claim_datas.per_input_material.iter().enumerate() {
587                                 match per_outp_material {
588                                         &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 } => {
589                                                 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) {
590
591                                                         let witness_script = if let Some(ref htlc) = *htlc {
592                                                                 chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, &chan_keys.broadcaster_htlc_key, &chan_keys.countersignatory_htlc_key, &chan_keys.revocation_key)
593                                                         } else {
594                                                                 chan_utils::get_revokeable_redeemscript(&chan_keys.revocation_key, *on_counterparty_tx_csv, &chan_keys.broadcaster_delayed_payment_key)
595                                                         };
596
597                                                         if let Ok(sig) = self.key_storage.sign_justice_transaction(&bumped_tx, i, *amount, &per_commitment_key, htlc, &self.secp_ctx) {
598                                                                 bumped_tx.input[i].witness.push(sig.serialize_der().to_vec());
599                                                                 bumped_tx.input[i].witness[0].push(SigHashType::All as u8);
600                                                                 if htlc.is_some() {
601                                                                         bumped_tx.input[i].witness.push(chan_keys.revocation_key.clone().serialize().to_vec());
602                                                                 } else {
603                                                                         bumped_tx.input[i].witness.push(vec!(1));
604                                                                 }
605                                                                 bumped_tx.input[i].witness.push(witness_script.clone().into_bytes());
606                                                         } else { return None; }
607                                                         //TODO: panic ?
608
609                                                         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);
610                                                 }
611                                         },
612                                         &InputMaterial::CounterpartyHTLC { ref per_commitment_point, ref counterparty_delayed_payment_base_key, ref counterparty_htlc_base_key, ref preimage, ref htlc } => {
613                                                 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) {
614                                                         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);
615
616                                                         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
617                                                         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) {
618                                                                 bumped_tx.input[i].witness.push(sig.serialize_der().to_vec());
619                                                                 bumped_tx.input[i].witness[0].push(SigHashType::All as u8);
620                                                                 if let &Some(preimage) = preimage {
621                                                                         bumped_tx.input[i].witness.push(preimage.0.to_vec());
622                                                                 } else {
623                                                                         // Due to BIP146 (MINIMALIF) this must be a zero-length element to relay.
624                                                                         bumped_tx.input[i].witness.push(vec![]);
625                                                                 }
626                                                                 bumped_tx.input[i].witness.push(witness_script.clone().into_bytes());
627                                                         }
628                                                         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);
629                                                 }
630                                         },
631                                         _ => unreachable!()
632                                 }
633                         }
634                         log_trace!(logger, "...with timer {}", new_timer.unwrap());
635                         assert!(predicted_weight >= bumped_tx.get_weight() as u64);
636                         return Some((new_timer, new_feerate as u32, bumped_tx))
637                 } else {
638                         for (_, (outp, per_outp_material)) in cached_claim_datas.per_input_material.iter().enumerate() {
639                                 match per_outp_material {
640                                         &InputMaterial::HolderHTLC { ref preimage, ref amount } => {
641                                                 let htlc_tx = self.get_fully_signed_htlc_tx(outp, preimage);
642                                                 if let Some(htlc_tx) = htlc_tx {
643                                                         let feerate = (amount - htlc_tx.output[0].value) * 1000 / htlc_tx.get_weight() as u64;
644                                                         // Timer set to $NEVER given we can't bump tx without anchor outputs
645                                                         log_trace!(logger, "Going to broadcast Holder HTLC-{} claiming HTLC output {} from {}...", if preimage.is_some() { "Success" } else { "Timeout" }, outp.vout, outp.txid);
646                                                         return Some((None, feerate as u32, htlc_tx));
647                                                 }
648                                                 return None;
649                                         },
650                                         &InputMaterial::Funding { ref funding_redeemscript } => {
651                                                 let signed_tx = self.get_fully_signed_holder_tx(funding_redeemscript).unwrap();
652                                                 // Timer set to $NEVER given we can't bump tx without anchor outputs
653                                                 log_trace!(logger, "Going to broadcast Holder Transaction {} claiming funding output {} from {}...", signed_tx.txid(), outp.vout, outp.txid);
654                                                 return Some((None, self.holder_commitment.as_ref().unwrap().feerate_per_kw(), signed_tx));
655                                         }
656                                         _ => unreachable!()
657                                 }
658                         }
659                 }
660                 None
661         }
662
663         /// Upon channelmonitor.block_connected(..) or upon provision of a preimage on the forward link
664         /// for this channel, provide new relevant on-chain transactions and/or new claim requests.
665         /// Formerly this was named `block_connected`, but it is now also used for claiming an HTLC output
666         /// if we receive a preimage after force-close.
667         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)
668                 where B::Target: BroadcasterInterface,
669                       F::Target: FeeEstimator,
670                                         L::Target: Logger,
671         {
672                 let height = match latest_height {
673                         Some(h) => h,
674                         None => self.latest_height,
675                 };
676                 log_trace!(logger, "Updating claims view at height {} with {} matched transactions and {} claim requests", height, txn_matched.len(), claimable_outpoints.len());
677                 let mut new_claims = Vec::new();
678                 let mut aggregated_claim = HashMap::new();
679                 let mut aggregated_soonest = ::std::u32::MAX;
680
681                 // Try to aggregate outputs if their timelock expiration isn't imminent (absolute_timelock
682                 // <= CLTV_SHARED_CLAIM_BUFFER) and they don't require an immediate nLockTime (aggregable).
683                 for req in claimable_outpoints {
684                         // Don't claim a outpoint twice that would be bad for privacy and may uselessly lock a CPFP input for a while
685                         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 {
686                                 log_trace!(logger, "Test if outpoint can be aggregated with expiration {} against {}", req.absolute_timelock, height + CLTV_SHARED_CLAIM_BUFFER);
687                                 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
688                                         let mut single_input = HashMap::new();
689                                         single_input.insert(req.outpoint, req.witness_data);
690                                         new_claims.push((req.absolute_timelock, single_input));
691                                 } else {
692                                         aggregated_claim.insert(req.outpoint, req.witness_data);
693                                         if req.absolute_timelock < aggregated_soonest {
694                                                 aggregated_soonest = req.absolute_timelock;
695                                         }
696                                 }
697                         }
698                 }
699                 new_claims.push((aggregated_soonest, aggregated_claim));
700
701                 // Generate claim transactions and track them to bump if necessary at
702                 // height timer expiration (i.e in how many blocks we're going to take action).
703                 for (soonest_timelock, claim) in new_claims.drain(..) {
704                         let mut claim_material = ClaimTxBumpMaterial { height_timer: None, feerate_previous: 0, soonest_timelock, per_input_material: claim };
705                         if let Some((new_timer, new_feerate, tx)) = self.generate_claim_tx(height, &claim_material, &*fee_estimator, &*logger) {
706                                 claim_material.height_timer = new_timer;
707                                 claim_material.feerate_previous = new_feerate;
708                                 let txid = tx.txid();
709                                 for k in claim_material.per_input_material.keys() {
710                                         log_trace!(logger, "Registering claiming request for {}:{}", k.txid, k.vout);
711                                         self.claimable_outpoints.insert(k.clone(), (txid, height));
712                                 }
713                                 self.pending_claim_requests.insert(txid, claim_material);
714                                 log_trace!(logger, "Broadcast onchain {}", log_tx!(tx));
715                                 broadcaster.broadcast_transaction(&tx);
716                         }
717                 }
718
719                 let mut bump_candidates = HashMap::new();
720                 for tx in txn_matched {
721                         // Scan all input to verify is one of the outpoint spent is of interest for us
722                         let mut claimed_outputs_material = Vec::new();
723                         for inp in &tx.input {
724                                 if let Some(first_claim_txid_height) = self.claimable_outpoints.get(&inp.previous_output) {
725                                         // If outpoint has claim request pending on it...
726                                         if let Some(claim_material) = self.pending_claim_requests.get_mut(&first_claim_txid_height.0) {
727                                                 //... we need to verify equality between transaction outpoints and claim request
728                                                 // outpoints to know if transaction is the original claim or a bumped one issued
729                                                 // by us.
730                                                 let mut set_equality = true;
731                                                 if claim_material.per_input_material.len() != tx.input.len() {
732                                                         set_equality = false;
733                                                 } else {
734                                                         for (claim_inp, tx_inp) in claim_material.per_input_material.keys().zip(tx.input.iter()) {
735                                                                 if *claim_inp != tx_inp.previous_output {
736                                                                         set_equality = false;
737                                                                 }
738                                                         }
739                                                 }
740
741                                                 macro_rules! clean_claim_request_after_safety_delay {
742                                                         () => {
743                                                                 let new_event = OnchainEvent::Claim { claim_request: first_claim_txid_height.0.clone() };
744                                                                 match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
745                                                                         hash_map::Entry::Occupied(mut entry) => {
746                                                                                 if !entry.get().contains(&new_event) {
747                                                                                         entry.get_mut().push(new_event);
748                                                                                 }
749                                                                         },
750                                                                         hash_map::Entry::Vacant(entry) => {
751                                                                                 entry.insert(vec![new_event]);
752                                                                         }
753                                                                 }
754                                                         }
755                                                 }
756
757                                                 // If this is our transaction (or our counterparty spent all the outputs
758                                                 // before we could anyway with same inputs order than us), wait for
759                                                 // ANTI_REORG_DELAY and clean the RBF tracking map.
760                                                 if set_equality {
761                                                         clean_claim_request_after_safety_delay!();
762                                                 } else { // If false, generate new claim request with update outpoint set
763                                                         let mut at_least_one_drop = false;
764                                                         for input in tx.input.iter() {
765                                                                 if let Some(input_material) = claim_material.per_input_material.remove(&input.previous_output) {
766                                                                         claimed_outputs_material.push((input.previous_output, input_material));
767                                                                         at_least_one_drop = true;
768                                                                 }
769                                                                 // If there are no outpoints left to claim in this request, drop it entirely after ANTI_REORG_DELAY.
770                                                                 if claim_material.per_input_material.is_empty() {
771                                                                         clean_claim_request_after_safety_delay!();
772                                                                 }
773                                                         }
774                                                         //TODO: recompute soonest_timelock to avoid wasting a bit on fees
775                                                         if at_least_one_drop {
776                                                                 bump_candidates.insert(first_claim_txid_height.0.clone(), claim_material.clone());
777                                                         }
778                                                 }
779                                                 break; //No need to iterate further, either tx is our or their
780                                         } else {
781                                                 panic!("Inconsistencies between pending_claim_requests map and claimable_outpoints map");
782                                         }
783                                 }
784                         }
785                         for (outpoint, input_material) in claimed_outputs_material.drain(..) {
786                                 let new_event = OnchainEvent::ContentiousOutpoint { outpoint, input_material };
787                                 match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
788                                         hash_map::Entry::Occupied(mut entry) => {
789                                                 if !entry.get().contains(&new_event) {
790                                                         entry.get_mut().push(new_event);
791                                                 }
792                                         },
793                                         hash_map::Entry::Vacant(entry) => {
794                                                 entry.insert(vec![new_event]);
795                                         }
796                                 }
797                         }
798                 }
799
800                 // After security delay, either our claim tx got enough confs or outpoint is definetely out of reach
801                 if let Some(events) = self.onchain_events_waiting_threshold_conf.remove(&height) {
802                         for ev in events {
803                                 match ev {
804                                         OnchainEvent::Claim { claim_request } => {
805                                                 // We may remove a whole set of claim outpoints here, as these one may have
806                                                 // been aggregated in a single tx and claimed so atomically
807                                                 if let Some(bump_material) = self.pending_claim_requests.remove(&claim_request) {
808                                                         for outpoint in bump_material.per_input_material.keys() {
809                                                                 self.claimable_outpoints.remove(&outpoint);
810                                                         }
811                                                 }
812                                         },
813                                         OnchainEvent::ContentiousOutpoint { outpoint, .. } => {
814                                                 self.claimable_outpoints.remove(&outpoint);
815                                         }
816                                 }
817                         }
818                 }
819
820                 // Check if any pending claim request must be rescheduled
821                 for (first_claim_txid, ref claim_data) in self.pending_claim_requests.iter() {
822                         if let Some(h) = claim_data.height_timer {
823                                 if h == height {
824                                         bump_candidates.insert(*first_claim_txid, (*claim_data).clone());
825                                 }
826                         }
827                 }
828
829                 // Build, bump and rebroadcast tx accordingly
830                 log_trace!(logger, "Bumping {} candidates", bump_candidates.len());
831                 for (first_claim_txid, claim_material) in bump_candidates.iter() {
832                         if let Some((new_timer, new_feerate, bump_tx)) = self.generate_claim_tx(height, &claim_material, &*fee_estimator, &*logger) {
833                                 log_trace!(logger, "Broadcast onchain {}", log_tx!(bump_tx));
834                                 broadcaster.broadcast_transaction(&bump_tx);
835                                 if let Some(claim_material) = self.pending_claim_requests.get_mut(first_claim_txid) {
836                                         claim_material.height_timer = new_timer;
837                                         claim_material.feerate_previous = new_feerate;
838                                 }
839                         }
840                 }
841         }
842
843         pub(crate) fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, height: u32, broadcaster: B, fee_estimator: F, logger: L)
844                 where B::Target: BroadcasterInterface,
845                       F::Target: FeeEstimator,
846                                         L::Target: Logger,
847         {
848                 let mut bump_candidates = HashMap::new();
849                 if let Some(events) = self.onchain_events_waiting_threshold_conf.remove(&(height + ANTI_REORG_DELAY - 1)) {
850                         //- our claim tx on a commitment tx output
851                         //- resurect outpoint back in its claimable set and regenerate tx
852                         for ev in events {
853                                 match ev {
854                                         OnchainEvent::ContentiousOutpoint { outpoint, input_material } => {
855                                                 if let Some(ancestor_claimable_txid) = self.claimable_outpoints.get(&outpoint) {
856                                                         if let Some(claim_material) = self.pending_claim_requests.get_mut(&ancestor_claimable_txid.0) {
857                                                                 claim_material.per_input_material.insert(outpoint, input_material);
858                                                                 // Using a HashMap guarantee us than if we have multiple outpoints getting
859                                                                 // resurrected only one bump claim tx is going to be broadcast
860                                                                 bump_candidates.insert(ancestor_claimable_txid.clone(), claim_material.clone());
861                                                         }
862                                                 }
863                                         },
864                                         _ => {},
865                                 }
866                         }
867                 }
868                 for (_, claim_material) in bump_candidates.iter_mut() {
869                         if let Some((new_timer, new_feerate, bump_tx)) = self.generate_claim_tx(height, &claim_material, &&*fee_estimator, &&*logger) {
870                                 claim_material.height_timer = new_timer;
871                                 claim_material.feerate_previous = new_feerate;
872                                 broadcaster.broadcast_transaction(&bump_tx);
873                         }
874                 }
875                 for (ancestor_claim_txid, claim_material) in bump_candidates.drain() {
876                         self.pending_claim_requests.insert(ancestor_claim_txid.0, claim_material);
877                 }
878                 //TODO: if we implement cross-block aggregated claim transaction we need to refresh set of outpoints and regenerate tx but
879                 // right now if one of the outpoint get disconnected, just erase whole pending claim request.
880                 let mut remove_request = Vec::new();
881                 self.claimable_outpoints.retain(|_, ref v|
882                         if v.1 == height {
883                         remove_request.push(v.0.clone());
884                         false
885                         } else { true });
886                 for req in remove_request {
887                         self.pending_claim_requests.remove(&req);
888                 }
889         }
890
891         pub(crate) fn provide_latest_holder_tx(&mut self, tx: HolderCommitmentTransaction) {
892                 self.prev_holder_commitment = self.holder_commitment.take();
893                 self.holder_commitment = Some(tx);
894         }
895
896         fn sign_latest_holder_htlcs(&mut self) {
897                 if let Some(ref holder_commitment) = self.holder_commitment {
898                         if let Ok(sigs) = self.key_storage.sign_holder_commitment_htlc_transactions(holder_commitment, &self.secp_ctx) {
899                                 self.holder_htlc_sigs = Some(Self::extract_holder_sigs(holder_commitment, sigs));
900                         }
901                 }
902         }
903
904         fn sign_prev_holder_htlcs(&mut self) {
905                 if let Some(ref holder_commitment) = self.prev_holder_commitment {
906                         if let Ok(sigs) = self.key_storage.sign_holder_commitment_htlc_transactions(holder_commitment, &self.secp_ctx) {
907                                 self.prev_holder_htlc_sigs = Some(Self::extract_holder_sigs(holder_commitment, sigs));
908                         }
909                 }
910         }
911
912         fn extract_holder_sigs(holder_commitment: &HolderCommitmentTransaction, sigs: Vec<Signature>) -> Vec<Option<(usize, Signature)>> {
913                 let mut ret = Vec::new();
914                 for (htlc_idx, (holder_sig, htlc)) in sigs.iter().zip(holder_commitment.htlcs().iter()).enumerate() {
915                         let tx_idx = htlc.transaction_output_index.unwrap();
916                         if ret.len() <= tx_idx as usize { ret.resize(tx_idx as usize + 1, None); }
917                         ret[tx_idx as usize] = Some((htlc_idx, holder_sig.clone()));
918                 }
919                 ret
920         }
921
922         //TODO: getting lastest holder transactions should be infallible and result in us "force-closing the channel", but we may
923         // have empty holder commitment transaction if a ChannelMonitor is asked to force-close just after Channel::get_outbound_funding_created,
924         // before providing a initial commitment transaction. For outbound channel, init ChannelMonitor at Channel::funding_signed, there is nothing
925         // to monitor before.
926         pub(crate) fn get_fully_signed_holder_tx(&mut self, funding_redeemscript: &Script) -> Option<Transaction> {
927                 if let Some(ref mut holder_commitment) = self.holder_commitment {
928                         match self.key_storage.sign_holder_commitment(&holder_commitment, &self.secp_ctx) {
929                                 Ok(sig) => {
930                                         Some(holder_commitment.add_holder_sig(funding_redeemscript, sig))
931                                 },
932                                 Err(_) => return None,
933                         }
934                 } else {
935                         None
936                 }
937         }
938
939         #[cfg(any(test, feature="unsafe_revoked_tx_signing"))]
940         pub(crate) fn get_fully_signed_copy_holder_tx(&mut self, funding_redeemscript: &Script) -> Option<Transaction> {
941                 if let Some(ref mut holder_commitment) = self.holder_commitment {
942                         match self.key_storage.sign_holder_commitment(holder_commitment, &self.secp_ctx) {
943                                 Ok(sig) => {
944                                         Some(holder_commitment.add_holder_sig(funding_redeemscript, sig))
945                                 },
946                                 Err(_) => return None,
947                         }
948                 } else {
949                         None
950                 }
951         }
952
953         pub(crate) fn get_fully_signed_htlc_tx(&mut self, outp: &::bitcoin::OutPoint, preimage: &Option<PaymentPreimage>) -> Option<Transaction> {
954                 let mut htlc_tx = None;
955                 if self.holder_commitment.is_some() {
956                         let commitment_txid = self.holder_commitment.as_ref().unwrap().trust().txid();
957                         if commitment_txid == outp.txid {
958                                 self.sign_latest_holder_htlcs();
959                                 if let &Some(ref htlc_sigs) = &self.holder_htlc_sigs {
960                                         let &(ref htlc_idx, ref htlc_sig) = htlc_sigs[outp.vout as usize].as_ref().unwrap();
961                                         let holder_commitment = self.holder_commitment.as_ref().unwrap();
962                                         let trusted_tx = holder_commitment.trust();
963                                         let counterparty_htlc_sig = holder_commitment.counterparty_htlc_sigs[*htlc_idx];
964                                         htlc_tx = Some(trusted_tx
965                                                 .get_signed_htlc_tx(&self.channel_transaction_parameters.as_holder_broadcastable(), *htlc_idx, &counterparty_htlc_sig, htlc_sig, preimage));
966                                 }
967                         }
968                 }
969                 if self.prev_holder_commitment.is_some() {
970                         let commitment_txid = self.prev_holder_commitment.as_ref().unwrap().trust().txid();
971                         if commitment_txid == outp.txid {
972                                 self.sign_prev_holder_htlcs();
973                                 if let &Some(ref htlc_sigs) = &self.prev_holder_htlc_sigs {
974                                         let &(ref htlc_idx, ref htlc_sig) = htlc_sigs[outp.vout as usize].as_ref().unwrap();
975                                         let holder_commitment = self.prev_holder_commitment.as_ref().unwrap();
976                                         let trusted_tx = holder_commitment.trust();
977                                         let counterparty_htlc_sig = holder_commitment.counterparty_htlc_sigs[*htlc_idx];
978                                         htlc_tx = Some(trusted_tx
979                                                 .get_signed_htlc_tx(&self.channel_transaction_parameters.as_holder_broadcastable(), *htlc_idx, &counterparty_htlc_sig, htlc_sig, preimage));
980                                 }
981                         }
982                 }
983                 htlc_tx
984         }
985
986         #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
987         pub(crate) fn unsafe_get_fully_signed_htlc_tx(&mut self, outp: &::bitcoin::OutPoint, preimage: &Option<PaymentPreimage>) -> Option<Transaction> {
988                 let latest_had_sigs = self.holder_htlc_sigs.is_some();
989                 let prev_had_sigs = self.prev_holder_htlc_sigs.is_some();
990                 let ret = self.get_fully_signed_htlc_tx(outp, preimage);
991                 if !latest_had_sigs {
992                         self.holder_htlc_sigs = None;
993                 }
994                 if !prev_had_sigs {
995                         self.prev_holder_htlc_sigs = None;
996                 }
997                 ret
998         }
999 }