1 // This file is Copyright its original authors, visible in version control
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
10 //! The logic to build claims and bump in-flight transactions until confirmations.
12 //! OnchainTxHandler objects are fully-part of ChannelMonitor and encapsulates all
13 //! building, tracking, bumping and notifications functions.
15 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut, SigHashType};
16 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
17 use bitcoin::blockdata::script::Script;
19 use bitcoin::hash_types::Txid;
21 use bitcoin::secp256k1::{Secp256k1, Signature};
22 use bitcoin::secp256k1;
24 use ln::msgs::DecodeError;
25 use ln::channelmanager::PaymentPreimage;
27 use ln::chan_utils::{TxCreationKeys, ChannelTransactionParameters, HolderCommitmentTransaction};
28 use chain::chaininterface::{FeeEstimator, BroadcasterInterface, ConfirmationTarget, MIN_RELAY_FEE_SAT_PER_1000_WEIGHT};
29 use chain::channelmonitor::{ANTI_REORG_DELAY, CLTV_SHARED_CLAIM_BUFFER, InputMaterial, ClaimRequest};
30 use chain::keysinterface::{ChannelKeys, KeysInterface};
31 use util::logger::Logger;
32 use util::ser::{Readable, ReadableArgs, Writer, Writeable, VecWriter};
35 use std::collections::{HashMap, hash_map};
39 const MAX_ALLOC_SIZE: usize = 64*1024;
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)]
45 /// Outpoint under claim process by our own tx, once this one get enough confirmations, we remove it from
46 /// bump-txn candidate buffer.
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.
54 outpoint: BitcoinOutPoint,
55 input_material: InputMaterial,
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>,
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() {
82 tx_material.write(writer)?;
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);
100 Ok(Self { height_timer, feerate_previous, soonest_timelock, per_input_material })
104 #[derive(PartialEq, Clone, Copy)]
105 pub(crate) enum InputDescriptors {
110 RevokedOutput, // either a revoked to_holder output on commitment tx, a revoked HTLC-Timeout output or a revoked HTLC-Success output
113 impl Writeable for InputDescriptors {
114 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
116 &InputDescriptors::RevokedOfferedHTLC => {
117 writer.write_all(&[0; 1])?;
119 &InputDescriptors::RevokedReceivedHTLC => {
120 writer.write_all(&[1; 1])?;
122 &InputDescriptors::OfferedHTLC => {
123 writer.write_all(&[2; 1])?;
125 &InputDescriptors::ReceivedHTLC => {
126 writer.write_all(&[3; 1])?;
128 &InputDescriptors::RevokedOutput => {
129 writer.write_all(&[4; 1])?;
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)? {
140 InputDescriptors::RevokedOfferedHTLC
143 InputDescriptors::RevokedReceivedHTLC
146 InputDescriptors::OfferedHTLC
149 InputDescriptors::ReceivedHTLC
152 InputDescriptors::RevokedOutput
154 _ => return Err(DecodeError::InvalidValue),
160 macro_rules! subtract_high_prio_fee {
161 ($logger: ident, $fee_estimator: expr, $value: expr, $predicted_weight: expr, $used_feerate: expr) => {
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;
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;
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)",
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)",
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)",
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)? {
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)>>()));
203 ret.push(match Readable::read(reader)? {
205 1u8 => Some((<u64 as Readable>::read(reader)? as usize, Readable::read(reader)?)),
206 _ => return Err(DecodeError::InvalidValue)
211 _ => Err(DecodeError::InvalidValue),
216 impl Writeable for Option<Vec<Option<(usize, Signature)>>> {
217 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
221 (vec.len() as u64).write(writer)?;
222 for opt in vec.iter() {
224 &Some((ref idx, ref sig)) => {
226 (*idx as u64).write(writer)?;
229 &None => 0u8.write(writer)?,
233 &None => 0u8.write(writer)?,
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)>>>,
252 key_storage: ChanSigner,
253 pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
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>,
269 pending_claim_requests: HashMap<Txid, ClaimTxBumpMaterial>,
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)>,
280 claimable_outpoints: HashMap<BitcoinOutPoint, (Txid, u32)>,
282 onchain_events_waiting_threshold_conf: HashMap<u32, Vec<OnchainEvent>>,
286 secp_ctx: Secp256k1<secp256k1::All>,
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)?;
297 self.channel_transaction_parameters.write(writer)?;
299 let mut key_data = VecWriter(Vec::new());
300 self.key_storage.write(&mut key_data)?;
301 assert!(key_data.0.len() < std::usize::MAX);
302 assert!(key_data.0.len() < std::u32::MAX as usize);
303 (key_data.0.len() as u32).write(writer)?;
304 writer.write_all(&key_data.0[..])?;
306 writer.write_all(&byte_utils::be64_to_array(self.pending_claim_requests.len() as u64))?;
307 for (ref ancestor_claim_txid, claim_tx_data) in self.pending_claim_requests.iter() {
308 ancestor_claim_txid.write(writer)?;
309 claim_tx_data.write(writer)?;
312 writer.write_all(&byte_utils::be64_to_array(self.claimable_outpoints.len() as u64))?;
313 for (ref outp, ref claim_and_height) in self.claimable_outpoints.iter() {
315 claim_and_height.0.write(writer)?;
316 claim_and_height.1.write(writer)?;
319 writer.write_all(&byte_utils::be64_to_array(self.onchain_events_waiting_threshold_conf.len() as u64))?;
320 for (ref target, ref events) in self.onchain_events_waiting_threshold_conf.iter() {
321 writer.write_all(&byte_utils::be32_to_array(**target))?;
322 writer.write_all(&byte_utils::be64_to_array(events.len() as u64))?;
323 for ev in events.iter() {
325 OnchainEvent::Claim { ref claim_request } => {
326 writer.write_all(&[0; 1])?;
327 claim_request.write(writer)?;
329 OnchainEvent::ContentiousOutpoint { ref outpoint, ref input_material } => {
330 writer.write_all(&[1; 1])?;
331 outpoint.write(writer)?;
332 input_material.write(writer)?;
337 self.latest_height.write(writer)?;
342 impl<'a, K: KeysInterface> ReadableArgs<&'a K> for OnchainTxHandler<K::ChanKeySigner> {
343 fn read<R: ::std::io::Read>(reader: &mut R, keys_manager: &'a K) -> Result<Self, DecodeError> {
344 let destination_script = Readable::read(reader)?;
346 let holder_commitment = Readable::read(reader)?;
347 let holder_htlc_sigs = Readable::read(reader)?;
348 let prev_holder_commitment = Readable::read(reader)?;
349 let prev_holder_htlc_sigs = Readable::read(reader)?;
351 let channel_parameters = Readable::read(reader)?;
353 let keys_len: u32 = Readable::read(reader)?;
354 let mut keys_data = Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE));
355 while keys_data.len() != keys_len as usize {
356 // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
357 let mut data = [0; 1024];
358 let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.len())];
359 reader.read_exact(read_slice)?;
360 keys_data.extend_from_slice(read_slice);
362 let key_storage = keys_manager.read_chan_signer(&keys_data)?;
364 let pending_claim_requests_len: u64 = Readable::read(reader)?;
365 let mut pending_claim_requests = HashMap::with_capacity(cmp::min(pending_claim_requests_len as usize, MAX_ALLOC_SIZE / 128));
366 for _ in 0..pending_claim_requests_len {
367 pending_claim_requests.insert(Readable::read(reader)?, Readable::read(reader)?);
370 let claimable_outpoints_len: u64 = Readable::read(reader)?;
371 let mut claimable_outpoints = HashMap::with_capacity(cmp::min(pending_claim_requests_len as usize, MAX_ALLOC_SIZE / 128));
372 for _ in 0..claimable_outpoints_len {
373 let outpoint = Readable::read(reader)?;
374 let ancestor_claim_txid = Readable::read(reader)?;
375 let height = Readable::read(reader)?;
376 claimable_outpoints.insert(outpoint, (ancestor_claim_txid, height));
378 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
379 let mut onchain_events_waiting_threshold_conf = HashMap::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
380 for _ in 0..waiting_threshold_conf_len {
381 let height_target = Readable::read(reader)?;
382 let events_len: u64 = Readable::read(reader)?;
383 let mut events = Vec::with_capacity(cmp::min(events_len as usize, MAX_ALLOC_SIZE / 128));
384 for _ in 0..events_len {
385 let ev = match <u8 as Readable>::read(reader)? {
387 let claim_request = Readable::read(reader)?;
388 OnchainEvent::Claim {
393 let outpoint = Readable::read(reader)?;
394 let input_material = Readable::read(reader)?;
395 OnchainEvent::ContentiousOutpoint {
400 _ => return Err(DecodeError::InvalidValue),
404 onchain_events_waiting_threshold_conf.insert(height_target, events);
406 let latest_height = Readable::read(reader)?;
408 Ok(OnchainTxHandler {
412 prev_holder_commitment,
413 prev_holder_htlc_sigs,
415 channel_transaction_parameters: channel_parameters,
417 pending_claim_requests,
418 onchain_events_waiting_threshold_conf,
420 secp_ctx: Secp256k1::new(),
425 impl<ChanSigner: ChannelKeys> OnchainTxHandler<ChanSigner> {
426 pub(crate) fn new(destination_script: Script, keys: ChanSigner, channel_parameters: ChannelTransactionParameters) -> Self {
428 let key_storage = keys;
432 holder_commitment: None,
433 holder_htlc_sigs: None,
434 prev_holder_commitment: None,
435 prev_holder_htlc_sigs: None,
437 channel_transaction_parameters: channel_parameters,
438 pending_claim_requests: HashMap::new(),
439 claimable_outpoints: HashMap::new(),
440 onchain_events_waiting_threshold_conf: HashMap::new(),
443 secp_ctx: Secp256k1::new(),
447 pub(crate) fn get_witnesses_weight(inputs: &[InputDescriptors]) -> usize {
448 let mut tx_weight = 2; // count segwit flags
450 // We use expected weight (and not actual) as signatures and time lock delays may vary
451 tx_weight += match inp {
452 // number_of_witness_elements + sig_length + revocation_sig + pubkey_length + revocationpubkey + witness_script_length + witness_script
453 &InputDescriptors::RevokedOfferedHTLC => {
454 1 + 1 + 73 + 1 + 33 + 1 + 133
456 // number_of_witness_elements + sig_length + revocation_sig + pubkey_length + revocationpubkey + witness_script_length + witness_script
457 &InputDescriptors::RevokedReceivedHTLC => {
458 1 + 1 + 73 + 1 + 33 + 1 + 139
460 // number_of_witness_elements + sig_length + counterpartyhtlc_sig + preimage_length + preimage + witness_script_length + witness_script
461 &InputDescriptors::OfferedHTLC => {
462 1 + 1 + 73 + 1 + 32 + 1 + 133
464 // number_of_witness_elements + sig_length + revocation_sig + pubkey_length + revocationpubkey + witness_script_length + witness_script
465 &InputDescriptors::ReceivedHTLC => {
466 1 + 1 + 73 + 1 + 1 + 1 + 139
468 // number_of_witness_elements + sig_length + revocation_sig + true_length + op_true + witness_script_length + witness_script
469 &InputDescriptors::RevokedOutput => {
470 1 + 1 + 73 + 1 + 1 + 1 + 77
477 /// In LN, output claimed are time-sensitive, which means we have to spend them before reaching some timelock expiration. At in-channel
478 /// output detection, we generate a first version of a claim tx and associate to it a height timer. A height timer is an absolute block
479 /// height than once reached we should generate a new bumped "version" of the claim tx to be sure than we safely claim outputs before
480 /// than our counterparty can do it too. If timelock expires soon, height timer is going to be scale down in consequence to increase
481 /// frequency of the bump and so increase our bets of success.
482 fn get_height_timer(current_height: u32, timelock_expiration: u32) -> u32 {
483 if timelock_expiration <= current_height + 3 {
484 return current_height + 1
485 } else if timelock_expiration - current_height <= 15 {
486 return current_height + 3
491 /// Lightning security model (i.e being able to redeem/timeout HTLC or penalize coutnerparty onchain) lays on the assumption of claim transactions getting confirmed before timelock expiration
492 /// (CSV or CLTV following cases). In case of high-fee spikes, claim tx may stuck in the mempool, so you need to bump its feerate quickly using Replace-By-Fee or Child-Pay-For-Parent.
493 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)>
494 where F::Target: FeeEstimator,
497 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
498 let mut inputs = Vec::new();
499 for outp in cached_claim_datas.per_input_material.keys() {
500 log_trace!(logger, "Outpoint {}:{}", outp.txid, outp.vout);
502 previous_output: *outp,
503 script_sig: Script::new(),
504 sequence: 0xfffffffd,
508 let mut bumped_tx = Transaction {
513 script_pubkey: self.destination_script.clone(),
518 macro_rules! RBF_bump {
519 ($amount: expr, $old_feerate: expr, $fee_estimator: expr, $predicted_weight: expr) => {
521 let mut used_feerate: u32;
522 // If old feerate inferior to actual one given back by Fee Estimator, use it to compute new fee...
523 let new_fee = if $old_feerate < $fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) {
524 let mut value = $amount;
525 if subtract_high_prio_fee!(logger, $fee_estimator, value, $predicted_weight, used_feerate) {
526 // Overflow check is done in subtract_high_prio_fee
529 log_trace!(logger, "Can't new-estimation bump new claiming tx, amount {} is too small", $amount);
532 // ...else just increase the previous feerate by 25% (because that's a nice number)
534 let fee = $old_feerate as u64 * ($predicted_weight as u64) / 750;
536 log_trace!(logger, "Can't 25% bump new claiming tx, amount {} is too small", $amount);
542 let previous_fee = $old_feerate as u64 * ($predicted_weight as u64) / 1000;
543 let min_relay_fee = MIN_RELAY_FEE_SAT_PER_1000_WEIGHT * ($predicted_weight as u64) / 1000;
544 // BIP 125 Opt-in Full Replace-by-Fee Signaling
545 // * 3. The replacement transaction pays an absolute fee of at least the sum paid by the original transactions.
546 // * 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.
547 let new_fee = if new_fee < previous_fee + min_relay_fee {
548 new_fee + previous_fee + min_relay_fee - new_fee
552 Some((new_fee, new_fee * 1000 / ($predicted_weight as u64)))
557 // Compute new height timer to decide when we need to regenerate a new bumped version of the claim tx (if we
558 // didn't receive confirmation of it before, or not enough reorg-safe depth on top of it).
559 let new_timer = Some(Self::get_height_timer(height, cached_claim_datas.soonest_timelock));
560 let mut inputs_witnesses_weight = 0;
562 let mut dynamic_fee = true;
563 for per_outp_material in cached_claim_datas.per_input_material.values() {
564 match per_outp_material {
565 &InputMaterial::Revoked { ref input_descriptor, ref amount, .. } => {
566 inputs_witnesses_weight += Self::get_witnesses_weight(&[*input_descriptor]);
569 &InputMaterial::CounterpartyHTLC { ref preimage, ref htlc, .. } => {
570 inputs_witnesses_weight += Self::get_witnesses_weight(if preimage.is_some() { &[InputDescriptors::OfferedHTLC] } else { &[InputDescriptors::ReceivedHTLC] });
571 amt += htlc.amount_msat / 1000;
573 &InputMaterial::HolderHTLC { .. } => {
576 &InputMaterial::Funding { .. } => {
582 let predicted_weight = (bumped_tx.get_weight() + inputs_witnesses_weight) as u64;
584 // If old feerate is 0, first iteration of this claim, use normal fee calculation
585 if cached_claim_datas.feerate_previous != 0 {
586 if let Some((new_fee, feerate)) = RBF_bump!(amt, cached_claim_datas.feerate_previous, fee_estimator, predicted_weight) {
587 // If new computed fee is superior at the whole claimable amount burn all in fees
588 if new_fee as u64 > amt {
589 bumped_tx.output[0].value = 0;
591 bumped_tx.output[0].value = amt - new_fee as u64;
593 new_feerate = feerate;
594 } else { return None; }
596 if subtract_high_prio_fee!(logger, fee_estimator, amt, predicted_weight, new_feerate) {
597 bumped_tx.output[0].value = amt;
598 } else { return None; }
600 assert!(new_feerate != 0);
602 for (i, (outp, per_outp_material)) in cached_claim_datas.per_input_material.iter().enumerate() {
603 match per_outp_material {
604 &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 } => {
605 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) {
607 let witness_script = if let Some(ref htlc) = *htlc {
608 chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, &chan_keys.broadcaster_htlc_key, &chan_keys.countersignatory_htlc_key, &chan_keys.revocation_key)
610 chan_utils::get_revokeable_redeemscript(&chan_keys.revocation_key, *on_counterparty_tx_csv, &chan_keys.broadcaster_delayed_payment_key)
613 if let Ok(sig) = self.key_storage.sign_justice_transaction(&bumped_tx, i, *amount, &per_commitment_key, htlc, &self.secp_ctx) {
614 bumped_tx.input[i].witness.push(sig.serialize_der().to_vec());
615 bumped_tx.input[i].witness[0].push(SigHashType::All as u8);
617 bumped_tx.input[i].witness.push(chan_keys.revocation_key.clone().serialize().to_vec());
619 bumped_tx.input[i].witness.push(vec!(1));
621 bumped_tx.input[i].witness.push(witness_script.clone().into_bytes());
622 } else { return None; }
625 log_trace!(logger, "Going to broadcast Penalty Transaction {} claiming revoked {} output {} from {} with new feerate {}...", bumped_tx.txid(), if *input_descriptor == InputDescriptors::RevokedOutput { "to_holder" } else if *input_descriptor == InputDescriptors::RevokedOfferedHTLC { "offered" } else if *input_descriptor == InputDescriptors::RevokedReceivedHTLC { "received" } else { "" }, outp.vout, outp.txid, new_feerate);
628 &InputMaterial::CounterpartyHTLC { ref per_commitment_point, ref counterparty_delayed_payment_base_key, ref counterparty_htlc_base_key, ref preimage, ref htlc } => {
629 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) {
630 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);
632 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
633 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) {
634 bumped_tx.input[i].witness.push(sig.serialize_der().to_vec());
635 bumped_tx.input[i].witness[0].push(SigHashType::All as u8);
636 if let &Some(preimage) = preimage {
637 bumped_tx.input[i].witness.push(preimage.0.to_vec());
639 // Due to BIP146 (MINIMALIF) this must be a zero-length element to relay.
640 bumped_tx.input[i].witness.push(vec![]);
642 bumped_tx.input[i].witness.push(witness_script.clone().into_bytes());
644 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);
650 log_trace!(logger, "...with timer {}", new_timer.unwrap());
651 assert!(predicted_weight >= bumped_tx.get_weight() as u64);
652 return Some((new_timer, new_feerate as u32, bumped_tx))
654 for (_, (outp, per_outp_material)) in cached_claim_datas.per_input_material.iter().enumerate() {
655 match per_outp_material {
656 &InputMaterial::HolderHTLC { ref preimage, ref amount } => {
657 let htlc_tx = self.get_fully_signed_htlc_tx(outp, preimage);
658 if let Some(htlc_tx) = htlc_tx {
659 let feerate = (amount - htlc_tx.output[0].value) * 1000 / htlc_tx.get_weight() as u64;
660 // Timer set to $NEVER given we can't bump tx without anchor outputs
661 log_trace!(logger, "Going to broadcast Holder HTLC-{} claiming HTLC output {} from {}...", if preimage.is_some() { "Success" } else { "Timeout" }, outp.vout, outp.txid);
662 return Some((None, feerate as u32, htlc_tx));
666 &InputMaterial::Funding { ref funding_redeemscript } => {
667 let signed_tx = self.get_fully_signed_holder_tx(funding_redeemscript).unwrap();
668 // Timer set to $NEVER given we can't bump tx without anchor outputs
669 log_trace!(logger, "Going to broadcast Holder Transaction {} claiming funding output {} from {}...", signed_tx.txid(), outp.vout, outp.txid);
670 return Some((None, self.holder_commitment.as_ref().unwrap().feerate_per_kw(), signed_tx));
679 /// Upon channelmonitor.block_connected(..) or upon provision of a preimage on the forward link
680 /// for this channel, provide new relevant on-chain transactions and/or new claim requests.
681 /// Formerly this was named `block_connected`, but it is now also used for claiming an HTLC output
682 /// if we receive a preimage after force-close.
683 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)
684 where B::Target: BroadcasterInterface,
685 F::Target: FeeEstimator,
688 let height = match latest_height {
690 None => self.latest_height,
692 log_trace!(logger, "Updating claims view at height {} with {} matched transactions and {} claim requests", height, txn_matched.len(), claimable_outpoints.len());
693 let mut new_claims = Vec::new();
694 let mut aggregated_claim = HashMap::new();
695 let mut aggregated_soonest = ::std::u32::MAX;
697 // Try to aggregate outputs if their timelock expiration isn't imminent (absolute_timelock
698 // <= CLTV_SHARED_CLAIM_BUFFER) and they don't require an immediate nLockTime (aggregable).
699 for req in claimable_outpoints {
700 // Don't claim a outpoint twice that would be bad for privacy and may uselessly lock a CPFP input for a while
701 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 {
702 log_trace!(logger, "Test if outpoint can be aggregated with expiration {} against {}", req.absolute_timelock, height + CLTV_SHARED_CLAIM_BUFFER);
703 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
704 let mut single_input = HashMap::new();
705 single_input.insert(req.outpoint, req.witness_data);
706 new_claims.push((req.absolute_timelock, single_input));
708 aggregated_claim.insert(req.outpoint, req.witness_data);
709 if req.absolute_timelock < aggregated_soonest {
710 aggregated_soonest = req.absolute_timelock;
715 new_claims.push((aggregated_soonest, aggregated_claim));
717 // Generate claim transactions and track them to bump if necessary at
718 // height timer expiration (i.e in how many blocks we're going to take action).
719 for (soonest_timelock, claim) in new_claims.drain(..) {
720 let mut claim_material = ClaimTxBumpMaterial { height_timer: None, feerate_previous: 0, soonest_timelock, per_input_material: claim };
721 if let Some((new_timer, new_feerate, tx)) = self.generate_claim_tx(height, &claim_material, &*fee_estimator, &*logger) {
722 claim_material.height_timer = new_timer;
723 claim_material.feerate_previous = new_feerate;
724 let txid = tx.txid();
725 for k in claim_material.per_input_material.keys() {
726 log_trace!(logger, "Registering claiming request for {}:{}", k.txid, k.vout);
727 self.claimable_outpoints.insert(k.clone(), (txid, height));
729 self.pending_claim_requests.insert(txid, claim_material);
730 log_trace!(logger, "Broadcast onchain {}", log_tx!(tx));
731 broadcaster.broadcast_transaction(&tx);
735 let mut bump_candidates = HashMap::new();
736 for tx in txn_matched {
737 // Scan all input to verify is one of the outpoint spent is of interest for us
738 let mut claimed_outputs_material = Vec::new();
739 for inp in &tx.input {
740 if let Some(first_claim_txid_height) = self.claimable_outpoints.get(&inp.previous_output) {
741 // If outpoint has claim request pending on it...
742 if let Some(claim_material) = self.pending_claim_requests.get_mut(&first_claim_txid_height.0) {
743 //... we need to verify equality between transaction outpoints and claim request
744 // outpoints to know if transaction is the original claim or a bumped one issued
746 let mut set_equality = true;
747 if claim_material.per_input_material.len() != tx.input.len() {
748 set_equality = false;
750 for (claim_inp, tx_inp) in claim_material.per_input_material.keys().zip(tx.input.iter()) {
751 if *claim_inp != tx_inp.previous_output {
752 set_equality = false;
757 macro_rules! clean_claim_request_after_safety_delay {
759 let new_event = OnchainEvent::Claim { claim_request: first_claim_txid_height.0.clone() };
760 match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
761 hash_map::Entry::Occupied(mut entry) => {
762 if !entry.get().contains(&new_event) {
763 entry.get_mut().push(new_event);
766 hash_map::Entry::Vacant(entry) => {
767 entry.insert(vec![new_event]);
773 // If this is our transaction (or our counterparty spent all the outputs
774 // before we could anyway with same inputs order than us), wait for
775 // ANTI_REORG_DELAY and clean the RBF tracking map.
777 clean_claim_request_after_safety_delay!();
778 } else { // If false, generate new claim request with update outpoint set
779 let mut at_least_one_drop = false;
780 for input in tx.input.iter() {
781 if let Some(input_material) = claim_material.per_input_material.remove(&input.previous_output) {
782 claimed_outputs_material.push((input.previous_output, input_material));
783 at_least_one_drop = true;
785 // If there are no outpoints left to claim in this request, drop it entirely after ANTI_REORG_DELAY.
786 if claim_material.per_input_material.is_empty() {
787 clean_claim_request_after_safety_delay!();
790 //TODO: recompute soonest_timelock to avoid wasting a bit on fees
791 if at_least_one_drop {
792 bump_candidates.insert(first_claim_txid_height.0.clone(), claim_material.clone());
795 break; //No need to iterate further, either tx is our or their
797 panic!("Inconsistencies between pending_claim_requests map and claimable_outpoints map");
801 for (outpoint, input_material) in claimed_outputs_material.drain(..) {
802 let new_event = OnchainEvent::ContentiousOutpoint { outpoint, input_material };
803 match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
804 hash_map::Entry::Occupied(mut entry) => {
805 if !entry.get().contains(&new_event) {
806 entry.get_mut().push(new_event);
809 hash_map::Entry::Vacant(entry) => {
810 entry.insert(vec![new_event]);
816 // After security delay, either our claim tx got enough confs or outpoint is definetely out of reach
817 if let Some(events) = self.onchain_events_waiting_threshold_conf.remove(&height) {
820 OnchainEvent::Claim { claim_request } => {
821 // We may remove a whole set of claim outpoints here, as these one may have
822 // been aggregated in a single tx and claimed so atomically
823 if let Some(bump_material) = self.pending_claim_requests.remove(&claim_request) {
824 for outpoint in bump_material.per_input_material.keys() {
825 self.claimable_outpoints.remove(&outpoint);
829 OnchainEvent::ContentiousOutpoint { outpoint, .. } => {
830 self.claimable_outpoints.remove(&outpoint);
836 // Check if any pending claim request must be rescheduled
837 for (first_claim_txid, ref claim_data) in self.pending_claim_requests.iter() {
838 if let Some(h) = claim_data.height_timer {
840 bump_candidates.insert(*first_claim_txid, (*claim_data).clone());
845 // Build, bump and rebroadcast tx accordingly
846 log_trace!(logger, "Bumping {} candidates", bump_candidates.len());
847 for (first_claim_txid, claim_material) in bump_candidates.iter() {
848 if let Some((new_timer, new_feerate, bump_tx)) = self.generate_claim_tx(height, &claim_material, &*fee_estimator, &*logger) {
849 log_trace!(logger, "Broadcast onchain {}", log_tx!(bump_tx));
850 broadcaster.broadcast_transaction(&bump_tx);
851 if let Some(claim_material) = self.pending_claim_requests.get_mut(first_claim_txid) {
852 claim_material.height_timer = new_timer;
853 claim_material.feerate_previous = new_feerate;
859 pub(crate) fn block_disconnected<B: Deref, F: Deref, L: Deref>(&mut self, height: u32, broadcaster: B, fee_estimator: F, logger: L)
860 where B::Target: BroadcasterInterface,
861 F::Target: FeeEstimator,
864 let mut bump_candidates = HashMap::new();
865 if let Some(events) = self.onchain_events_waiting_threshold_conf.remove(&(height + ANTI_REORG_DELAY - 1)) {
866 //- our claim tx on a commitment tx output
867 //- resurect outpoint back in its claimable set and regenerate tx
870 OnchainEvent::ContentiousOutpoint { outpoint, input_material } => {
871 if let Some(ancestor_claimable_txid) = self.claimable_outpoints.get(&outpoint) {
872 if let Some(claim_material) = self.pending_claim_requests.get_mut(&ancestor_claimable_txid.0) {
873 claim_material.per_input_material.insert(outpoint, input_material);
874 // Using a HashMap guarantee us than if we have multiple outpoints getting
875 // resurrected only one bump claim tx is going to be broadcast
876 bump_candidates.insert(ancestor_claimable_txid.clone(), claim_material.clone());
884 for (_, claim_material) in bump_candidates.iter_mut() {
885 if let Some((new_timer, new_feerate, bump_tx)) = self.generate_claim_tx(height, &claim_material, &&*fee_estimator, &&*logger) {
886 claim_material.height_timer = new_timer;
887 claim_material.feerate_previous = new_feerate;
888 broadcaster.broadcast_transaction(&bump_tx);
891 for (ancestor_claim_txid, claim_material) in bump_candidates.drain() {
892 self.pending_claim_requests.insert(ancestor_claim_txid.0, claim_material);
894 //TODO: if we implement cross-block aggregated claim transaction we need to refresh set of outpoints and regenerate tx but
895 // right now if one of the outpoint get disconnected, just erase whole pending claim request.
896 let mut remove_request = Vec::new();
897 self.claimable_outpoints.retain(|_, ref v|
899 remove_request.push(v.0.clone());
902 for req in remove_request {
903 self.pending_claim_requests.remove(&req);
907 pub(crate) fn provide_latest_holder_tx(&mut self, tx: HolderCommitmentTransaction) {
908 self.prev_holder_commitment = self.holder_commitment.take();
909 self.holder_commitment = Some(tx);
912 fn sign_latest_holder_htlcs(&mut self) {
913 if let Some(ref holder_commitment) = self.holder_commitment {
914 if let Ok(sigs) = self.key_storage.sign_holder_commitment_htlc_transactions(holder_commitment, &self.secp_ctx) {
915 self.holder_htlc_sigs = Some(Self::extract_holder_sigs(holder_commitment, sigs));
920 fn sign_prev_holder_htlcs(&mut self) {
921 if let Some(ref holder_commitment) = self.prev_holder_commitment {
922 if let Ok(sigs) = self.key_storage.sign_holder_commitment_htlc_transactions(holder_commitment, &self.secp_ctx) {
923 self.prev_holder_htlc_sigs = Some(Self::extract_holder_sigs(holder_commitment, sigs));
928 fn extract_holder_sigs(holder_commitment: &HolderCommitmentTransaction, sigs: Vec<Signature>) -> Vec<Option<(usize, Signature)>> {
929 let mut ret = Vec::new();
930 for (htlc_idx, (holder_sig, htlc)) in sigs.iter().zip(holder_commitment.htlcs().iter()).enumerate() {
931 let tx_idx = htlc.transaction_output_index.unwrap();
932 if ret.len() <= tx_idx as usize { ret.resize(tx_idx as usize + 1, None); }
933 ret[tx_idx as usize] = Some((htlc_idx, holder_sig.clone()));
938 //TODO: getting lastest holder transactions should be infallible and result in us "force-closing the channel", but we may
939 // have empty holder commitment transaction if a ChannelMonitor is asked to force-close just after Channel::get_outbound_funding_created,
940 // before providing a initial commitment transaction. For outbound channel, init ChannelMonitor at Channel::funding_signed, there is nothing
941 // to monitor before.
942 pub(crate) fn get_fully_signed_holder_tx(&mut self, funding_redeemscript: &Script) -> Option<Transaction> {
943 if let Some(ref mut holder_commitment) = self.holder_commitment {
944 match self.key_storage.sign_holder_commitment(&holder_commitment, &self.secp_ctx) {
946 Some(holder_commitment.add_holder_sig(funding_redeemscript, sig))
948 Err(_) => return None,
955 #[cfg(any(test, feature="unsafe_revoked_tx_signing"))]
956 pub(crate) fn get_fully_signed_copy_holder_tx(&mut self, funding_redeemscript: &Script) -> Option<Transaction> {
957 if let Some(ref mut holder_commitment) = self.holder_commitment {
958 match self.key_storage.sign_holder_commitment(holder_commitment, &self.secp_ctx) {
960 Some(holder_commitment.add_holder_sig(funding_redeemscript, sig))
962 Err(_) => return None,
969 pub(crate) fn get_fully_signed_htlc_tx(&mut self, outp: &::bitcoin::OutPoint, preimage: &Option<PaymentPreimage>) -> Option<Transaction> {
970 let mut htlc_tx = None;
971 if self.holder_commitment.is_some() {
972 let commitment_txid = self.holder_commitment.as_ref().unwrap().trust().txid();
973 if commitment_txid == outp.txid {
974 self.sign_latest_holder_htlcs();
975 if let &Some(ref htlc_sigs) = &self.holder_htlc_sigs {
976 let &(ref htlc_idx, ref htlc_sig) = htlc_sigs[outp.vout as usize].as_ref().unwrap();
977 let holder_commitment = self.holder_commitment.as_ref().unwrap();
978 let trusted_tx = holder_commitment.trust();
979 let counterparty_htlc_sig = holder_commitment.counterparty_htlc_sigs[*htlc_idx];
980 htlc_tx = Some(trusted_tx
981 .get_signed_htlc_tx(&self.channel_transaction_parameters.as_holder_broadcastable(), *htlc_idx, &counterparty_htlc_sig, htlc_sig, preimage));
985 if self.prev_holder_commitment.is_some() {
986 let commitment_txid = self.prev_holder_commitment.as_ref().unwrap().trust().txid();
987 if commitment_txid == outp.txid {
988 self.sign_prev_holder_htlcs();
989 if let &Some(ref htlc_sigs) = &self.prev_holder_htlc_sigs {
990 let &(ref htlc_idx, ref htlc_sig) = htlc_sigs[outp.vout as usize].as_ref().unwrap();
991 let holder_commitment = self.prev_holder_commitment.as_ref().unwrap();
992 let trusted_tx = holder_commitment.trust();
993 let counterparty_htlc_sig = holder_commitment.counterparty_htlc_sigs[*htlc_idx];
994 htlc_tx = Some(trusted_tx
995 .get_signed_htlc_tx(&self.channel_transaction_parameters.as_holder_broadcastable(), *htlc_idx, &counterparty_htlc_sig, htlc_sig, preimage));
1002 #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
1003 pub(crate) fn unsafe_get_fully_signed_htlc_tx(&mut self, outp: &::bitcoin::OutPoint, preimage: &Option<PaymentPreimage>) -> Option<Transaction> {
1004 let latest_had_sigs = self.holder_htlc_sigs.is_some();
1005 let prev_had_sigs = self.prev_holder_htlc_sigs.is_some();
1006 let ret = self.get_fully_signed_htlc_tx(outp, preimage);
1007 if !latest_had_sigs {
1008 self.holder_htlc_sigs = None;
1011 self.prev_holder_htlc_sigs = None;