X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fln%2Fchannelmonitor.rs;h=ea84b984ed7bb122e540c99fb102c7d62498bba9;hb=8defcf1107a7f564ebce0048dd98ae72f2026db6;hp=1957128a1d3733d0f6fef67f8be17e6bee043d6c;hpb=f71518365f61a5fe2a0340953ad6592c0d2b72cc;p=rust-lightning diff --git a/lightning/src/ln/channelmonitor.rs b/lightning/src/ln/channelmonitor.rs index 1957128a..ea84b984 100644 --- a/lightning/src/ln/channelmonitor.rs +++ b/lightning/src/ln/channelmonitor.rs @@ -34,14 +34,14 @@ use ln::chan_utils; use ln::chan_utils::HTLCOutputInCommitment; use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash}; use ln::channel::{ACCEPTED_HTLC_SCRIPT_WEIGHT, OFFERED_HTLC_SCRIPT_WEIGHT}; -use chain::chaininterface::{ChainListener, ChainWatchInterface, BroadcasterInterface, FeeEstimator, ConfirmationTarget}; +use chain::chaininterface::{ChainListener, ChainWatchInterface, BroadcasterInterface, FeeEstimator, ConfirmationTarget, MIN_RELAY_FEE_SAT_PER_1000_WEIGHT}; use chain::transaction::OutPoint; use chain::keysinterface::SpendableOutputDescriptor; use util::logger::Logger; use util::ser::{ReadableArgs, Readable, Writer, Writeable, WriterWriteAdaptor, U48}; use util::{byte_utils, events}; -use std::collections::{HashMap, hash_map}; +use std::collections::{HashMap, hash_map, HashSet}; use std::sync::{Arc,Mutex}; use std::{hash,cmp, mem}; @@ -212,7 +212,7 @@ impl<'a, Key : Send + cmp::Eq + hash::Hash> ChainListener for SimpleManyChannelM let block_hash = header.bitcoin_hash(); let mut monitors = self.monitors.lock().unwrap(); for monitor in monitors.values_mut() { - monitor.block_disconnected(disconnected_height, &block_hash); + monitor.block_disconnected(disconnected_height, &block_hash, &*self.broadcaster, &*self.fee_estimator); } } } @@ -374,7 +374,7 @@ enum InputDescriptors { /// to generate a tx to push channel state forward, we cache outpoint-solving tx material to build /// a new bumped one in case of lenghty confirmation delay #[derive(Clone, PartialEq)] -enum TxMaterial { +enum InputMaterial { Revoked { script: Script, pubkey: Option, @@ -387,6 +387,7 @@ enum TxMaterial { key: SecretKey, preimage: Option, amount: u64, + locktime: u32, }, LocalHTLC { script: Script, @@ -396,6 +397,96 @@ enum TxMaterial { } } +impl Writeable for InputMaterial { + fn write(&self, writer: &mut W) -> Result<(), ::std::io::Error> { + match self { + &InputMaterial::Revoked { ref script, ref pubkey, ref key, ref is_htlc, ref amount} => { + writer.write_all(&[0; 1])?; + script.write(writer)?; + pubkey.write(writer)?; + writer.write_all(&key[..])?; + if *is_htlc { + writer.write_all(&[0; 1])?; + } else { + writer.write_all(&[1; 1])?; + } + writer.write_all(&byte_utils::be64_to_array(*amount))?; + }, + &InputMaterial::RemoteHTLC { ref script, ref key, ref preimage, ref amount, ref locktime } => { + writer.write_all(&[1; 1])?; + script.write(writer)?; + key.write(writer)?; + preimage.write(writer)?; + writer.write_all(&byte_utils::be64_to_array(*amount))?; + writer.write_all(&byte_utils::be32_to_array(*locktime))?; + }, + &InputMaterial::LocalHTLC { ref script, ref sigs, ref preimage, ref amount } => { + writer.write_all(&[2; 1])?; + script.write(writer)?; + sigs.0.write(writer)?; + sigs.1.write(writer)?; + preimage.write(writer)?; + writer.write_all(&byte_utils::be64_to_array(*amount))?; + } + } + Ok(()) + } +} + +impl Readable for InputMaterial { + fn read(reader: &mut R) -> Result { + let input_material = match >::read(reader)? { + 0 => { + let script = Readable::read(reader)?; + let pubkey = Readable::read(reader)?; + let key = Readable::read(reader)?; + let is_htlc = match >::read(reader)? { + 0 => true, + 1 => false, + _ => return Err(DecodeError::InvalidValue), + }; + let amount = Readable::read(reader)?; + InputMaterial::Revoked { + script, + pubkey, + key, + is_htlc, + amount + } + }, + 1 => { + let script = Readable::read(reader)?; + let key = Readable::read(reader)?; + let preimage = Readable::read(reader)?; + let amount = Readable::read(reader)?; + let locktime = Readable::read(reader)?; + InputMaterial::RemoteHTLC { + script, + key, + preimage, + amount, + locktime + } + }, + 2 => { + let script = Readable::read(reader)?; + let their_sig = Readable::read(reader)?; + let our_sig = Readable::read(reader)?; + let preimage = Readable::read(reader)?; + let amount = Readable::read(reader)?; + InputMaterial::LocalHTLC { + script, + sigs: (their_sig, our_sig), + preimage, + amount + } + } + _ => return Err(DecodeError::InvalidValue), + }; + Ok(input_material) + } +} + /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it /// once they mature to enough confirmations (ANTI_REORG_DELAY) #[derive(Clone, PartialEq)] @@ -403,7 +494,7 @@ enum OnchainEvent { /// Outpoint under claim process by our own tx, once this one get enough confirmations, we remove it from /// bump-txn candidate buffer. Claim { - outpoint: BitcoinOutPoint, + claim_request: Sha256dHash, }, /// HTLC output getting solved by a timeout, at maturation we pass upstream payment source information to solve /// inbound HTLC in backward channel. Note, in case of preimage, we pass info to upstream without delay as we can @@ -411,6 +502,58 @@ enum OnchainEvent { HTLCUpdate { htlc_update: (HTLCSource, PaymentHash), }, + /// Claim tx aggregate multiple claimable outpoints. One of the outpoint may be claimed by a remote party tx. + /// In this case, we need to drop the outpoint and regenerate a new claim tx. By safety, we keep tracking + /// the outpoint to be sure to resurect it back to the claim tx if reorgs happen. + ContentiousOutpoint { + outpoint: BitcoinOutPoint, + input_material: InputMaterial, + } +} + +/// Higher-level cache structure needed to re-generate bumped claim txn if needed +#[derive(Clone, PartialEq)] +pub struct ClaimTxBumpMaterial { + // At every block tick, used to check if pending claiming tx is taking too + // much time for confirmation and we need to bump it. + height_timer: u32, + // Tracked in case of reorg to wipe out now-superflous bump material + feerate_previous: u64, + // Soonest timelocks among set of outpoints claimed, used to compute + // a priority of not feerate + soonest_timelock: u32, + // Cache of script, pubkey, sig or key to solve claimable outputs scriptpubkey. + per_input_material: HashMap, +} + +impl Writeable for ClaimTxBumpMaterial { + fn write(&self, writer: &mut W) -> Result<(), ::std::io::Error> { + writer.write_all(&byte_utils::be32_to_array(self.height_timer))?; + writer.write_all(&byte_utils::be64_to_array(self.feerate_previous))?; + writer.write_all(&byte_utils::be32_to_array(self.soonest_timelock))?; + writer.write_all(&byte_utils::be64_to_array(self.per_input_material.len() as u64))?; + for (outp, tx_material) in self.per_input_material.iter() { + outp.write(writer)?; + tx_material.write(writer)?; + } + Ok(()) + } +} + +impl Readable for ClaimTxBumpMaterial { + fn read(reader: &mut R) -> Result { + let height_timer = Readable::read(reader)?; + let feerate_previous = Readable::read(reader)?; + let soonest_timelock = Readable::read(reader)?; + let per_input_material_len: u64 = Readable::read(reader)?; + let mut per_input_material = HashMap::with_capacity(cmp::min(per_input_material_len as usize, MAX_ALLOC_SIZE / 128)); + for _ in 0 ..per_input_material_len { + let outpoint = Readable::read(reader)?; + let input_material = Readable::read(reader)?; + per_input_material.insert(outpoint, input_material); + } + Ok(Self { height_timer, feerate_previous, soonest_timelock, per_input_material }) + } } const SERIALIZATION_VERSION: u8 = 1; @@ -467,13 +610,32 @@ pub struct ChannelMonitor { // scan every commitment transaction for that to_remote_rescue: Option<(Script, SecretKey)>, - // Used to track outpoint in the process of being claimed by our transactions. We need to scan all transactions - // for inputs spending this. If height timer (u32) is expired and claim tx hasn't reached enough confirmations - // before, use TxMaterial to regenerate a new claim tx with a satoshis-per-1000-weight-units higher than last - // one (u64), if timelock expiration (u32) is near, decrease height timer, the in-between bumps delay. - // Last field cached (u32) is height of outpoint confirmation, which is needed to flush this tracker - // in case of reorgs, given block timer are scaled on timer expiration we can't deduce from it original height. - our_claim_txn_waiting_first_conf: HashMap, + // Used to track claiming requests. If claim tx doesn't confirm before height timer expiration we need to bump + // it (RBF or CPFP). If an input has been part of an aggregate tx at first claim try, we need to keep it within + // another bumped aggregate tx to comply with RBF rules. We may have multiple claiming txn in the flight for the + // same set of outpoints. One of the outpoints may be spent by a transaction not issued by us. That's why at + // block connection we scan all inputs and if any of them is among a set of a claiming request we test for set + // equality between spending transaction and claim request. If true, it means transaction was one our claiming one + // after a security delay of 6 blocks we remove pending claim request. If false, it means transaction wasn't and + // we need to regenerate new claim request we reduced set of stil-claimable outpoints. + // Key is identifier of the pending claim request, i.e the txid of the initial claiming transaction generated by + // us and is immutable until all outpoint of the claimable set are post-anti-reorg-delay solved. + // Entry is cache of elements need to generate a bumped claiming transaction (see ClaimTxBumpMaterial) + #[cfg(test)] // Used in functional_test to verify sanitization + pub pending_claim_requests: HashMap, + #[cfg(not(test))] + pending_claim_requests: HashMap, + + // Used to link outpoints claimed in a connected block to a pending claim request. + // Key is outpoint than monitor parsing has detected we have keys/scripts to claim + // Value is (pending claim request identifier, confirmation_block), identifier + // is txid of the initial claiming transaction and is immutable until outpoint is + // post-anti-reorg-delay solved, confirmaiton_block is used to erase entry if + // block with output gets disconnected. + #[cfg(test)] // Used in functional_test to verify sanitization + pub claimable_outpoints: HashMap, + #[cfg(not(test))] + claimable_outpoints: HashMap, // Used to track onchain events, i.e transactions parts of channels confirmed on chain, on which // we have to take actions once they reach enough confs. Key is a block height timer, i.e we enforce @@ -491,7 +653,7 @@ pub struct ChannelMonitor { } macro_rules! subtract_high_prio_fee { - ($self: ident, $fee_estimator: expr, $value: expr, $predicted_weight: expr, $spent_txid: expr, $used_feerate: expr) => { + ($self: ident, $fee_estimator: expr, $value: expr, $predicted_weight: expr, $used_feerate: expr) => { { $used_feerate = $fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority); let mut fee = $used_feerate * ($predicted_weight as u64) / 1000; @@ -502,18 +664,18 @@ macro_rules! subtract_high_prio_fee { $used_feerate = $fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background); fee = $used_feerate * ($predicted_weight as u64) / 1000; if $value <= fee { - log_error!($self, "Failed to generate an on-chain punishment tx spending {} as even low priority fee ({} sat) was more than the entire claim balance ({} sat)", - $spent_txid, fee, $value); + log_error!($self, "Failed to generate an on-chain punishment tx as even low priority fee ({} sat) was more than the entire claim balance ({} sat)", + fee, $value); false } else { - log_warn!($self, "Used low priority fee for on-chain punishment tx spending {} as high priority fee was more than the entire claim balance ({} sat)", - $spent_txid, $value); + log_warn!($self, "Used low priority fee for on-chain punishment tx as high priority fee was more than the entire claim balance ({} sat)", + $value); $value -= fee; true } } else { - log_warn!($self, "Used medium priority fee for on-chain punishment tx spending {} as high priority fee was more than the entire claim balance ({} sat)", - $spent_txid, $value); + log_warn!($self, "Used medium priority fee for on-chain punishment tx as high priority fee was more than the entire claim balance ({} sat)", + $value); $value -= fee; true } @@ -546,7 +708,8 @@ impl PartialEq for ChannelMonitor { self.payment_preimages != other.payment_preimages || self.destination_script != other.destination_script || self.to_remote_rescue != other.to_remote_rescue || - self.our_claim_txn_waiting_first_conf != other.our_claim_txn_waiting_first_conf || + self.pending_claim_requests != other.pending_claim_requests || + self.claimable_outpoints != other.claimable_outpoints || self.onchain_events_waiting_threshold_conf != other.onchain_events_waiting_threshold_conf { false @@ -598,7 +761,9 @@ impl ChannelMonitor { destination_script: destination_script, to_remote_rescue: None, - our_claim_txn_waiting_first_conf: HashMap::new(), + pending_claim_requests: HashMap::new(), + + claimable_outpoints: HashMap::new(), onchain_events_waiting_threshold_conf: HashMap::new(), @@ -1142,42 +1307,17 @@ impl ChannelMonitor { writer.write_all(&[0; 1])?; } - writer.write_all(&byte_utils::be64_to_array(self.our_claim_txn_waiting_first_conf.len() as u64))?; - for (ref outpoint, claim_tx_data) in self.our_claim_txn_waiting_first_conf.iter() { - outpoint.write(writer)?; - writer.write_all(&byte_utils::be32_to_array(claim_tx_data.0))?; - match claim_tx_data.1 { - TxMaterial::Revoked { ref script, ref pubkey, ref key, ref is_htlc, ref amount} => { - writer.write_all(&[0; 1])?; - script.write(writer)?; - pubkey.write(writer)?; - writer.write_all(&key[..])?; - if *is_htlc { - writer.write_all(&[0; 1])?; - } else { - writer.write_all(&[1; 1])?; - } - writer.write_all(&byte_utils::be64_to_array(*amount))?; - }, - TxMaterial::RemoteHTLC { ref script, ref key, ref preimage, ref amount } => { - writer.write_all(&[1; 1])?; - script.write(writer)?; - key.write(writer)?; - preimage.write(writer)?; - writer.write_all(&byte_utils::be64_to_array(*amount))?; - }, - TxMaterial::LocalHTLC { ref script, ref sigs, ref preimage, ref amount } => { - writer.write_all(&[2; 1])?; - script.write(writer)?; - sigs.0.write(writer)?; - sigs.1.write(writer)?; - preimage.write(writer)?; - writer.write_all(&byte_utils::be64_to_array(*amount))?; - } - } - writer.write_all(&byte_utils::be64_to_array(claim_tx_data.2))?; - writer.write_all(&byte_utils::be32_to_array(claim_tx_data.3))?; - writer.write_all(&byte_utils::be32_to_array(claim_tx_data.4))?; + writer.write_all(&byte_utils::be64_to_array(self.pending_claim_requests.len() as u64))?; + for (ref ancestor_claim_txid, claim_tx_data) in self.pending_claim_requests.iter() { + ancestor_claim_txid.write(writer)?; + claim_tx_data.write(writer)?; + } + + writer.write_all(&byte_utils::be64_to_array(self.claimable_outpoints.len() as u64))?; + for (ref outp, ref claim_and_height) in self.claimable_outpoints.iter() { + outp.write(writer)?; + claim_and_height.0.write(writer)?; + claim_and_height.1.write(writer)?; } writer.write_all(&byte_utils::be64_to_array(self.onchain_events_waiting_threshold_conf.len() as u64))?; @@ -1186,14 +1326,19 @@ impl ChannelMonitor { writer.write_all(&byte_utils::be64_to_array(events.len() as u64))?; for ev in events.iter() { match *ev { - OnchainEvent::Claim { ref outpoint } => { + OnchainEvent::Claim { ref claim_request } => { writer.write_all(&[0; 1])?; - outpoint.write(writer)?; + claim_request.write(writer)?; }, OnchainEvent::HTLCUpdate { ref htlc_update } => { writer.write_all(&[1; 1])?; htlc_update.0.write(writer)?; htlc_update.1.write(writer)?; + }, + OnchainEvent::ContentiousOutpoint { ref outpoint, ref input_material } => { + writer.write_all(&[2; 1])?; + outpoint.write(writer)?; + input_material.write(writer)?; } } } @@ -1411,13 +1556,20 @@ impl ChannelMonitor { let predicted_weight = single_htlc_tx.get_weight() + Self::get_witnesses_weight(&[if htlc.offered { InputDescriptors::RevokedOfferedHTLC } else { InputDescriptors::RevokedReceivedHTLC }]); let height_timer = Self::get_height_timer(height, htlc.cltv_expiry); let mut used_feerate; - if subtract_high_prio_fee!(self, fee_estimator, single_htlc_tx.output[0].value, predicted_weight, tx.txid(), used_feerate) { + if subtract_high_prio_fee!(self, fee_estimator, single_htlc_tx.output[0].value, predicted_weight, used_feerate) { let sighash_parts = bip143::SighashComponents::new(&single_htlc_tx); let (redeemscript, revocation_key) = sign_input!(sighash_parts, single_htlc_tx.input[0], Some(idx), htlc.amount_msat / 1000); assert!(predicted_weight >= single_htlc_tx.get_weight()); - match self.our_claim_txn_waiting_first_conf.entry(single_htlc_tx.input[0].previous_output.clone()) { + log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", single_htlc_tx.input[0].previous_output.txid, single_htlc_tx.input[0].previous_output.vout, height_timer); + let mut per_input_material = HashMap::with_capacity(1); + per_input_material.insert(single_htlc_tx.input[0].previous_output, InputMaterial::Revoked { script: redeemscript, pubkey: Some(revocation_pubkey), key: revocation_key, is_htlc: true, amount: htlc.amount_msat / 1000 }); + match self.claimable_outpoints.entry(single_htlc_tx.input[0].previous_output) { hash_map::Entry::Occupied(_) => {}, - hash_map::Entry::Vacant(entry) => { entry.insert((height_timer, TxMaterial::Revoked { script: redeemscript, pubkey: Some(revocation_pubkey), key: revocation_key, is_htlc: true, amount: htlc.amount_msat / 1000 }, used_feerate, htlc.cltv_expiry, height)); } + hash_map::Entry::Vacant(entry) => { entry.insert((single_htlc_tx.txid(), height)); } + } + match self.pending_claim_requests.entry(single_htlc_tx.txid()) { + hash_map::Entry::Occupied(_) => {}, + hash_map::Entry::Vacant(entry) => { entry.insert(ClaimTxBumpMaterial { height_timer, feerate_previous: used_feerate, soonest_timelock: htlc.cltv_expiry, per_input_material }); } } txn_to_broadcast.push(single_htlc_tx); } @@ -1486,20 +1638,35 @@ impl ChannelMonitor { let predicted_weight = spend_tx.get_weight() + Self::get_witnesses_weight(&inputs_desc[..]); let mut used_feerate; - if !subtract_high_prio_fee!(self, fee_estimator, spend_tx.output[0].value, predicted_weight, tx.txid(), used_feerate) { + if !subtract_high_prio_fee!(self, fee_estimator, spend_tx.output[0].value, predicted_weight, used_feerate) { return (txn_to_broadcast, (commitment_txid, watch_outputs), spendable_outputs); } let sighash_parts = bip143::SighashComponents::new(&spend_tx); + let mut per_input_material = HashMap::with_capacity(spend_tx.input.len()); + let mut soonest_timelock = ::std::u32::MAX; + for info in inputs_info.iter() { + if info.2 <= soonest_timelock { + soonest_timelock = info.2; + } + } + let height_timer = Self::get_height_timer(height, soonest_timelock); + let spend_txid = spend_tx.txid(); for (input, info) in spend_tx.input.iter_mut().zip(inputs_info.iter()) { let (redeemscript, revocation_key) = sign_input!(sighash_parts, input, info.0, info.1); - let height_timer = Self::get_height_timer(height, info.2); - match self.our_claim_txn_waiting_first_conf.entry(input.previous_output.clone()) { + log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", input.previous_output.txid, input.previous_output.vout, height_timer); + per_input_material.insert(input.previous_output, InputMaterial::Revoked { script: redeemscript, pubkey: if info.0.is_some() { Some(revocation_pubkey) } else { None }, key: revocation_key, is_htlc: if info.0.is_some() { true } else { false }, amount: info.1 }); + match self.claimable_outpoints.entry(input.previous_output) { hash_map::Entry::Occupied(_) => {}, - hash_map::Entry::Vacant(entry) => { entry.insert((height_timer, TxMaterial::Revoked { script: redeemscript, pubkey: if info.0.is_some() { Some(revocation_pubkey) } else { None }, key: revocation_key, is_htlc: if info.0.is_some() { true } else { false }, amount: info.1 }, used_feerate, if !info.0.is_some() { height + info.2 } else { info.2 }, height)); } + hash_map::Entry::Vacant(entry) => { entry.insert((spend_txid, height)); } } } + match self.pending_claim_requests.entry(spend_txid) { + hash_map::Entry::Occupied(_) => {}, + hash_map::Entry::Vacant(entry) => { entry.insert(ClaimTxBumpMaterial { height_timer, feerate_previous: used_feerate, soonest_timelock, per_input_material }); } + } + assert!(predicted_weight >= spend_tx.get_weight()); spendable_outputs.push(SpendableOutputDescriptor::StaticOutput { @@ -1677,7 +1844,7 @@ impl ChannelMonitor { let predicted_weight = single_htlc_tx.get_weight() + Self::get_witnesses_weight(&[if htlc.offered { InputDescriptors::OfferedHTLC } else { InputDescriptors::ReceivedHTLC }]); let height_timer = Self::get_height_timer(height, htlc.cltv_expiry); let mut used_feerate; - if subtract_high_prio_fee!(self, fee_estimator, single_htlc_tx.output[0].value, predicted_weight, tx.txid(), used_feerate) { + if subtract_high_prio_fee!(self, fee_estimator, single_htlc_tx.output[0].value, predicted_weight, used_feerate) { let sighash_parts = bip143::SighashComponents::new(&single_htlc_tx); let (redeemscript, htlc_key) = sign_input!(sighash_parts, single_htlc_tx.input[0], htlc.amount_msat / 1000, payment_preimage.0.to_vec()); assert!(predicted_weight >= single_htlc_tx.get_weight()); @@ -1685,9 +1852,16 @@ impl ChannelMonitor { outpoint: BitcoinOutPoint { txid: single_htlc_tx.txid(), vout: 0 }, output: single_htlc_tx.output[0].clone(), }); - match self.our_claim_txn_waiting_first_conf.entry(single_htlc_tx.input[0].previous_output.clone()) { + log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", single_htlc_tx.input[0].previous_output.txid, single_htlc_tx.input[0].previous_output.vout, height_timer); + let mut per_input_material = HashMap::with_capacity(1); + per_input_material.insert(single_htlc_tx.input[0].previous_output, InputMaterial::RemoteHTLC { script: redeemscript, key: htlc_key, preimage: Some(*payment_preimage), amount: htlc.amount_msat / 1000, locktime: 0 }); + match self.claimable_outpoints.entry(single_htlc_tx.input[0].previous_output) { + hash_map::Entry::Occupied(_) => {}, + hash_map::Entry::Vacant(entry) => { entry.insert((single_htlc_tx.txid(), height)); } + } + match self.pending_claim_requests.entry(single_htlc_tx.txid()) { hash_map::Entry::Occupied(_) => {}, - hash_map::Entry::Vacant(entry) => { entry.insert((height_timer, TxMaterial::RemoteHTLC { script: redeemscript, key: htlc_key, preimage: Some(*payment_preimage), amount: htlc.amount_msat / 1000 }, used_feerate, htlc.cltv_expiry, height)); } + hash_map::Entry::Vacant(entry) => { entry.insert(ClaimTxBumpMaterial { height_timer, feerate_previous: used_feerate, soonest_timelock: htlc.cltv_expiry, per_input_material}); } } txn_to_broadcast.push(single_htlc_tx); } @@ -1718,14 +1892,21 @@ impl ChannelMonitor { let predicted_weight = timeout_tx.get_weight() + Self::get_witnesses_weight(&[InputDescriptors::ReceivedHTLC]); let height_timer = Self::get_height_timer(height, htlc.cltv_expiry); let mut used_feerate; - if subtract_high_prio_fee!(self, fee_estimator, timeout_tx.output[0].value, predicted_weight, tx.txid(), used_feerate) { + if subtract_high_prio_fee!(self, fee_estimator, timeout_tx.output[0].value, predicted_weight, used_feerate) { let sighash_parts = bip143::SighashComponents::new(&timeout_tx); let (redeemscript, htlc_key) = sign_input!(sighash_parts, timeout_tx.input[0], htlc.amount_msat / 1000, vec![0]); assert!(predicted_weight >= timeout_tx.get_weight()); //TODO: track SpendableOutputDescriptor - match self.our_claim_txn_waiting_first_conf.entry(timeout_tx.input[0].previous_output.clone()) { + log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", timeout_tx.input[0].previous_output.txid, timeout_tx.input[0].previous_output.vout, height_timer); + let mut per_input_material = HashMap::with_capacity(1); + per_input_material.insert(timeout_tx.input[0].previous_output, InputMaterial::RemoteHTLC { script : redeemscript, key: htlc_key, preimage: None, amount: htlc.amount_msat / 1000, locktime: htlc.cltv_expiry }); + match self.claimable_outpoints.entry(timeout_tx.input[0].previous_output) { hash_map::Entry::Occupied(_) => {}, - hash_map::Entry::Vacant(entry) => { entry.insert((height_timer, TxMaterial::RemoteHTLC { script : redeemscript, key: htlc_key, preimage: None, amount: htlc.amount_msat / 1000 }, used_feerate, htlc.cltv_expiry, height)); } + hash_map::Entry::Vacant(entry) => { entry.insert((timeout_tx.txid(), height)); } + } + match self.pending_claim_requests.entry(timeout_tx.txid()) { + hash_map::Entry::Occupied(_) => {}, + hash_map::Entry::Vacant(entry) => { entry.insert(ClaimTxBumpMaterial { height_timer, feerate_previous: used_feerate, soonest_timelock: htlc.cltv_expiry, per_input_material }); } } } txn_to_broadcast.push(timeout_tx); @@ -1749,20 +1930,34 @@ impl ChannelMonitor { let predicted_weight = spend_tx.get_weight() + Self::get_witnesses_weight(&inputs_desc[..]); let mut used_feerate; - if !subtract_high_prio_fee!(self, fee_estimator, spend_tx.output[0].value, predicted_weight, tx.txid(), used_feerate) { + if !subtract_high_prio_fee!(self, fee_estimator, spend_tx.output[0].value, predicted_weight, used_feerate) { return (txn_to_broadcast, (commitment_txid, watch_outputs), spendable_outputs); } let sighash_parts = bip143::SighashComponents::new(&spend_tx); + let mut per_input_material = HashMap::with_capacity(spend_tx.input.len()); + let mut soonest_timelock = ::std::u32::MAX; + for info in inputs_info.iter() { + if info.2 <= soonest_timelock { + soonest_timelock = info.2; + } + } + let height_timer = Self::get_height_timer(height, soonest_timelock); + let spend_txid = spend_tx.txid(); for (input, info) in spend_tx.input.iter_mut().zip(inputs_info.iter()) { let (redeemscript, htlc_key) = sign_input!(sighash_parts, input, info.1, (info.0).0.to_vec()); - let height_timer = Self::get_height_timer(height, info.2); - match self.our_claim_txn_waiting_first_conf.entry(input.previous_output.clone()) { + log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", input.previous_output.txid, input.previous_output.vout, height_timer); + per_input_material.insert(input.previous_output, InputMaterial::RemoteHTLC { script: redeemscript, key: htlc_key, preimage: Some(*(info.0)), amount: info.1, locktime: 0}); + match self.claimable_outpoints.entry(input.previous_output) { hash_map::Entry::Occupied(_) => {}, - hash_map::Entry::Vacant(entry) => { entry.insert((height_timer, TxMaterial::RemoteHTLC { script: redeemscript, key: htlc_key, preimage: Some(*(info.0)), amount: info.1}, used_feerate, info.2, height)); } + hash_map::Entry::Vacant(entry) => { entry.insert((spend_txid, height)); } } } + match self.pending_claim_requests.entry(spend_txid) { + hash_map::Entry::Occupied(_) => {}, + hash_map::Entry::Vacant(entry) => { entry.insert(ClaimTxBumpMaterial { height_timer, feerate_previous: used_feerate, soonest_timelock, per_input_material }); } + } assert!(predicted_weight >= spend_tx.get_weight()); spendable_outputs.push(SpendableOutputDescriptor::StaticOutput { outpoint: BitcoinOutPoint { txid: spend_tx.txid(), vout: 0 }, @@ -1788,6 +1983,7 @@ impl ChannelMonitor { /// Attempts to claim a remote HTLC-Success/HTLC-Timeout's outputs using the revocation key fn check_spend_remote_htlc(&mut self, tx: &Transaction, commitment_number: u64, height: u32, fee_estimator: &FeeEstimator) -> (Option, Option) { + //TODO: send back new outputs to guarantee pending_claim_request consistency if tx.input.len() != 1 || tx.output.len() != 1 { return (None, None) } @@ -1850,7 +2046,7 @@ impl ChannelMonitor { }; let predicted_weight = spend_tx.get_weight() + Self::get_witnesses_weight(&[InputDescriptors::RevokedOutput]); let mut used_feerate; - if !subtract_high_prio_fee!(self, fee_estimator, spend_tx.output[0].value, predicted_weight, tx.txid(), used_feerate) { + if !subtract_high_prio_fee!(self, fee_estimator, spend_tx.output[0].value, predicted_weight, used_feerate) { return (None, None); } @@ -1875,15 +2071,22 @@ impl ChannelMonitor { let outpoint = BitcoinOutPoint { txid: spend_tx.txid(), vout: 0 }; let output = spend_tx.output[0].clone(); let height_timer = Self::get_height_timer(height, self.their_to_self_delay.unwrap() as u32); // We can safely unwrap given we are past channel opening - match self.our_claim_txn_waiting_first_conf.entry(spend_tx.input[0].previous_output.clone()) { + log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", spend_tx.input[0].previous_output.txid, spend_tx.input[0].previous_output.vout, height_timer); + let mut per_input_material = HashMap::with_capacity(1); + per_input_material.insert(spend_tx.input[0].previous_output, InputMaterial::Revoked { script: redeemscript, pubkey: None, key: revocation_key, is_htlc: false, amount: tx.output[0].value }); + match self.claimable_outpoints.entry(spend_tx.input[0].previous_output) { hash_map::Entry::Occupied(_) => {}, - hash_map::Entry::Vacant(entry) => { entry.insert((height_timer, TxMaterial::Revoked { script: redeemscript, pubkey: None, key: revocation_key, is_htlc: false, amount: tx.output[0].value }, used_feerate, height + self.our_to_self_delay as u32, height)); } + hash_map::Entry::Vacant(entry) => { entry.insert((spend_tx.txid(), height)); } + } + match self.pending_claim_requests.entry(spend_tx.txid()) { + hash_map::Entry::Occupied(_) => {}, + hash_map::Entry::Vacant(entry) => { entry.insert(ClaimTxBumpMaterial { height_timer, feerate_previous: used_feerate, soonest_timelock: height + self.our_to_self_delay as u32, per_input_material }); } } (Some(spend_tx), Some(SpendableOutputDescriptor::StaticOutput { outpoint, output })) } else { (None, None) } } - fn broadcast_by_local_state(&self, local_tx: &LocalSignedTx, per_commitment_point: &Option, delayed_payment_base_key: &Option, height: u32) -> (Vec, Vec, Vec, Vec<(BitcoinOutPoint, (u32, TxMaterial, u64, u32, u32))>) { + fn broadcast_by_local_state(&self, local_tx: &LocalSignedTx, per_commitment_point: &Option, delayed_payment_base_key: &Option, height: u32) -> (Vec, Vec, Vec, Vec<(Sha256dHash, ClaimTxBumpMaterial)>) { let mut res = Vec::with_capacity(local_tx.htlc_outputs.len()); let mut spendable_outputs = Vec::with_capacity(local_tx.htlc_outputs.len()); let mut watch_outputs = Vec::with_capacity(local_tx.htlc_outputs.len()); @@ -1907,7 +2110,6 @@ impl ChannelMonitor { } } - let redeemscript = chan_utils::get_revokeable_redeemscript(&local_tx.revocation_key, self.their_to_self_delay.unwrap(), &local_tx.delayed_payment_key); let revokeable_p2wsh = redeemscript.to_v0_p2wsh(); for (idx, output) in local_tx.tx.output.iter().enumerate() { @@ -1937,7 +2139,11 @@ impl ChannelMonitor { add_dynamic_output!(htlc_timeout_tx, 0); let height_timer = Self::get_height_timer(height, htlc.cltv_expiry); - pending_claims.push((htlc_timeout_tx.input[0].previous_output.clone(), (height_timer, TxMaterial::LocalHTLC { script: htlc_script, sigs: (*their_sig, *our_sig), preimage: None, amount: htlc.amount_msat / 1000}, 0, htlc.cltv_expiry, height))); + let mut per_input_material = HashMap::with_capacity(1); + per_input_material.insert(htlc_timeout_tx.input[0].previous_output, InputMaterial::LocalHTLC { script: htlc_script, sigs: (*their_sig, *our_sig), preimage: None, amount: htlc.amount_msat / 1000}); + //TODO: with option_simplified_commitment track outpoint too + log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", htlc_timeout_tx.input[0].previous_output.vout, htlc_timeout_tx.input[0].previous_output.txid, height_timer); + pending_claims.push((htlc_timeout_tx.txid(), ClaimTxBumpMaterial { height_timer, feerate_previous: 0, soonest_timelock: htlc.cltv_expiry, per_input_material })); res.push(htlc_timeout_tx); } else { if let Some(payment_preimage) = self.payment_preimages.get(&htlc.payment_hash) { @@ -1957,7 +2163,11 @@ impl ChannelMonitor { add_dynamic_output!(htlc_success_tx, 0); let height_timer = Self::get_height_timer(height, htlc.cltv_expiry); - pending_claims.push((htlc_success_tx.input[0].previous_output.clone(), (height_timer, TxMaterial::LocalHTLC { script: htlc_script, sigs: (*their_sig, *our_sig), preimage: Some(*payment_preimage), amount: htlc.amount_msat / 1000}, 0, htlc.cltv_expiry, height))); + let mut per_input_material = HashMap::with_capacity(1); + per_input_material.insert(htlc_success_tx.input[0].previous_output, InputMaterial::LocalHTLC { script: htlc_script, sigs: (*their_sig, *our_sig), preimage: Some(*payment_preimage), amount: htlc.amount_msat / 1000}); + //TODO: with option_simplified_commitment track outpoint too + log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", htlc_success_tx.input[0].previous_output.vout, htlc_success_tx.input[0].previous_output.txid, height_timer); + pending_claims.push((htlc_success_tx.txid(), ClaimTxBumpMaterial { height_timer, feerate_previous: 0, soonest_timelock: htlc.cltv_expiry, per_input_material })); res.push(htlc_success_tx); } } @@ -2007,7 +2217,7 @@ impl ChannelMonitor { spendable_outputs.append(&mut $updates.1); watch_outputs.append(&mut $updates.2); for claim in $updates.3 { - match self.our_claim_txn_waiting_first_conf.entry(claim.0) { + match self.pending_claim_requests.entry(claim.0) { hash_map::Entry::Occupied(_) => {}, hash_map::Entry::Vacant(entry) => { entry.insert(claim.1); } } @@ -2123,9 +2333,11 @@ impl ChannelMonitor { } fn block_connected(&mut self, txn_matched: &[&Transaction], height: u32, block_hash: &Sha256dHash, broadcaster: &BroadcasterInterface, fee_estimator: &FeeEstimator)-> (Vec<(Sha256dHash, Vec)>, Vec, Vec<(HTLCSource, Option, PaymentHash)>) { + log_trace!(self, "Block {} at height {} connected with {} txn matched", block_hash, height, txn_matched.len()); let mut watch_outputs = Vec::new(); let mut spendable_outputs = Vec::new(); let mut htlc_updated = Vec::new(); + let mut bump_candidates = HashSet::new(); for tx in txn_matched { if tx.input.len() == 1 { // Assuming our keys were not leaked (in which case we're screwed no matter what), @@ -2176,6 +2388,7 @@ impl ChannelMonitor { } } for tx in txn.iter() { + log_trace!(self, "Broadcast onchain {}", log_tx!(tx)); broadcaster.broadcast_transaction(tx); } } @@ -2186,89 +2399,201 @@ impl ChannelMonitor { if updated.len() > 0 { htlc_updated.append(&mut updated); } + + // Scan all input to verify is one of the outpoint spent is of interest for us + let mut claimed_outputs_material = Vec::new(); for inp in &tx.input { - if self.our_claim_txn_waiting_first_conf.contains_key(&inp.previous_output) { - match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) { - hash_map::Entry::Occupied(mut entry) => { - let e = entry.get_mut(); - e.retain(|ref event| { - match **event { - OnchainEvent::Claim { outpoint } => { - return outpoint != inp.previous_output + if let Some(first_claim_txid_height) = self.claimable_outpoints.get(&inp.previous_output) { + // If outpoint has claim request pending on it... + if let Some(claim_material) = self.pending_claim_requests.get_mut(&first_claim_txid_height.0) { + //... we need to verify equality between transaction outpoints and claim request + // outpoints to know if transaction is the original claim or a bumped one issued + // by us. + let mut set_equality = true; + if claim_material.per_input_material.len() != tx.input.len() { + set_equality = false; + } else { + for (claim_inp, tx_inp) in claim_material.per_input_material.keys().zip(tx.input.iter()) { + if *claim_inp != tx_inp.previous_output { + set_equality = false; + } + } + } + + macro_rules! clean_claim_request_after_safety_delay { + () => { + let new_event = OnchainEvent::Claim { claim_request: first_claim_txid_height.0.clone() }; + match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) { + hash_map::Entry::Occupied(mut entry) => { + if !entry.get().contains(&new_event) { + entry.get_mut().push(new_event); + } }, - _ => return true + hash_map::Entry::Vacant(entry) => { + entry.insert(vec![new_event]); + } } - }); - e.push(OnchainEvent::Claim { outpoint: inp.previous_output.clone()}); + } } - hash_map::Entry::Vacant(entry) => { - entry.insert(vec![OnchainEvent::Claim { outpoint: inp.previous_output.clone()}]); + + // If this is our transaction (or our counterparty spent all the outputs + // before we could anyway with same inputs order than us), wait for + // ANTI_REORG_DELAY and clean the RBF tracking map. + if set_equality { + clean_claim_request_after_safety_delay!(); + } else { // If false, generate new claim request with update outpoint set + for input in tx.input.iter() { + if let Some(input_material) = claim_material.per_input_material.remove(&input.previous_output) { + claimed_outputs_material.push((input.previous_output, input_material)); + } + // If there are no outpoints left to claim in this request, drop it entirely after ANTI_REORG_DELAY. + if claim_material.per_input_material.is_empty() { + clean_claim_request_after_safety_delay!(); + } + } + //TODO: recompute soonest_timelock to avoid wasting a bit on fees + bump_candidates.insert(first_claim_txid_height.0.clone()); } + break; //No need to iterate further, either tx is our or their + } else { + panic!("Inconsistencies between pending_claim_requests map and claimable_outpoints map"); + } + } + } + for (outpoint, input_material) in claimed_outputs_material.drain(..) { + let new_event = OnchainEvent::ContentiousOutpoint { outpoint, input_material }; + match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) { + hash_map::Entry::Occupied(mut entry) => { + if !entry.get().contains(&new_event) { + entry.get_mut().push(new_event); + } + }, + hash_map::Entry::Vacant(entry) => { + entry.insert(vec![new_event]); } } } } - let mut pending_claims = Vec::new(); if let Some(ref cur_local_tx) = self.current_local_signed_commitment_tx { if self.would_broadcast_at_height(height) { + log_trace!(self, "Broadcast onchain {}", log_tx!(cur_local_tx.tx)); broadcaster.broadcast_transaction(&cur_local_tx.tx); match self.key_storage { Storage::Local { ref delayed_payment_base_key, ref latest_per_commitment_point, .. } => { - let (txs, mut spendable_output, new_outputs, mut pending_txn) = self.broadcast_by_local_state(&cur_local_tx, latest_per_commitment_point, &Some(*delayed_payment_base_key), height); + let (txs, mut spendable_output, new_outputs, _) = self.broadcast_by_local_state(&cur_local_tx, latest_per_commitment_point, &Some(*delayed_payment_base_key), height); spendable_outputs.append(&mut spendable_output); - pending_claims.append(&mut pending_txn); if !new_outputs.is_empty() { watch_outputs.push((cur_local_tx.txid.clone(), new_outputs)); } for tx in txs { + log_trace!(self, "Broadcast onchain {}", log_tx!(tx)); broadcaster.broadcast_transaction(&tx); } }, Storage::Watchtower { .. } => { - let (txs, mut spendable_output, new_outputs, mut pending_txn) = self.broadcast_by_local_state(&cur_local_tx, &None, &None, height); + let (txs, mut spendable_output, new_outputs, _) = self.broadcast_by_local_state(&cur_local_tx, &None, &None, height); spendable_outputs.append(&mut spendable_output); - pending_claims.append(&mut pending_txn); if !new_outputs.is_empty() { watch_outputs.push((cur_local_tx.txid.clone(), new_outputs)); } for tx in txs { + log_trace!(self, "Broadcast onchain {}", log_tx!(tx)); broadcaster.broadcast_transaction(&tx); } } } } } - for claim in pending_claims { - match self.our_claim_txn_waiting_first_conf.entry(claim.0) { - hash_map::Entry::Occupied(_) => {}, - hash_map::Entry::Vacant(entry) => { entry.insert(claim.1); } - } - } if let Some(events) = self.onchain_events_waiting_threshold_conf.remove(&height) { for ev in events { match ev { - OnchainEvent::Claim { outpoint } => { - self.our_claim_txn_waiting_first_conf.remove(&outpoint); + OnchainEvent::Claim { claim_request } => { + // We may remove a whole set of claim outpoints here, as these one may have + // been aggregated in a single tx and claimed so atomically + if let Some(bump_material) = self.pending_claim_requests.remove(&claim_request) { + for outpoint in bump_material.per_input_material.keys() { + self.claimable_outpoints.remove(&outpoint); + } + } }, OnchainEvent::HTLCUpdate { htlc_update } => { log_trace!(self, "HTLC {} failure update has got enough confirmations to be passed upstream", log_bytes!((htlc_update.1).0)); htlc_updated.push((htlc_update.0, None, htlc_update.1)); }, + OnchainEvent::ContentiousOutpoint { outpoint, .. } => { + self.claimable_outpoints.remove(&outpoint); + } } } } - //TODO: iter on buffered TxMaterial in our_claim_txn_waiting_first_conf, if block timer is expired generate a bumped claim tx (RBF or CPFP accordingly) + for (first_claim_txid, ref mut cached_claim_datas) in self.pending_claim_requests.iter_mut() { + if cached_claim_datas.height_timer == height { + bump_candidates.insert(first_claim_txid.clone()); + } + } + for first_claim_txid in bump_candidates.iter() { + if let Some((new_timer, new_feerate)) = { + if let Some(claim_material) = self.pending_claim_requests.get(first_claim_txid) { + if let Some((new_timer, new_feerate, bump_tx)) = self.bump_claim_tx(height, &claim_material, fee_estimator) { + broadcaster.broadcast_transaction(&bump_tx); + Some((new_timer, new_feerate)) + } else { None } + } else { unreachable!(); } + } { + if let Some(claim_material) = self.pending_claim_requests.get_mut(first_claim_txid) { + claim_material.height_timer = new_timer; + claim_material.feerate_previous = new_feerate; + } else { unreachable!(); } + } + } self.last_block_hash = block_hash.clone(); (watch_outputs, spendable_outputs, htlc_updated) } - fn block_disconnected(&mut self, height: u32, block_hash: &Sha256dHash) { - if let Some(_) = self.onchain_events_waiting_threshold_conf.remove(&(height + ANTI_REORG_DELAY - 1)) { + fn block_disconnected(&mut self, height: u32, block_hash: &Sha256dHash, broadcaster: &BroadcasterInterface, fee_estimator: &FeeEstimator) { + let mut bump_candidates = HashMap::new(); + if let Some(events) = self.onchain_events_waiting_threshold_conf.remove(&(height + ANTI_REORG_DELAY - 1)) { //We may discard: //- htlc update there as failure-trigger tx (revoked commitment tx, non-revoked commitment tx, HTLC-timeout tx) has been disconnected //- our claim tx on a commitment tx output + //- resurect outpoint back in its claimable set and regenerate tx + for ev in events { + match ev { + OnchainEvent::ContentiousOutpoint { outpoint, input_material } => { + if let Some(ancestor_claimable_txid) = self.claimable_outpoints.get(&outpoint) { + if let Some(claim_material) = self.pending_claim_requests.get_mut(&ancestor_claimable_txid.0) { + claim_material.per_input_material.insert(outpoint, input_material); + // Using a HashMap guarantee us than if we have multiple outpoints getting + // resurrected only one bump claim tx is going to be broadcast + bump_candidates.insert(ancestor_claimable_txid.clone(), claim_material.clone()); + } + } + }, + _ => {}, + } + } + } + for (_, claim_material) in bump_candidates.iter_mut() { + if let Some((new_timer, new_feerate, bump_tx)) = self.bump_claim_tx(height, &claim_material, fee_estimator) { + claim_material.height_timer = new_timer; + claim_material.feerate_previous = new_feerate; + broadcaster.broadcast_transaction(&bump_tx); + } + } + for (ancestor_claim_txid, claim_material) in bump_candidates.drain() { + self.pending_claim_requests.insert(ancestor_claim_txid.0, claim_material); + } + //TODO: if we implement cross-block aggregated claim transaction we need to refresh set of outpoints and regenerate tx but + // right now if one of the outpoint get disconnected, just erase whole pending claim request. + let mut remove_request = Vec::new(); + self.claimable_outpoints.retain(|_, ref v| + if v.1 == height { + remove_request.push(v.0.clone()); + false + } else { true }); + for req in remove_request { + self.pending_claim_requests.remove(&req); } - self.our_claim_txn_waiting_first_conf.retain(|_, ref mut v| if v.3 == height { false } else { true }); self.last_block_hash = block_hash.clone(); } @@ -2471,6 +2796,143 @@ impl ChannelMonitor { } htlc_updated } + + /// 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 + /// (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. + fn bump_claim_tx(&self, height: u32, cached_claim_datas: &ClaimTxBumpMaterial, fee_estimator: &FeeEstimator) -> Option<(u32, u64, Transaction)> { + 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 + let mut inputs = Vec::new(); + for outp in cached_claim_datas.per_input_material.keys() { + inputs.push(TxIn { + previous_output: *outp, + script_sig: Script::new(), + sequence: 0xfffffffd, + witness: Vec::new(), + }); + } + let mut bumped_tx = Transaction { + version: 2, + lock_time: 0, + input: inputs, + output: vec![TxOut { + script_pubkey: self.destination_script.clone(), + value: 0 + }], + }; + + macro_rules! RBF_bump { + ($amount: expr, $old_feerate: expr, $fee_estimator: expr, $predicted_weight: expr) => { + { + let mut used_feerate; + // If old feerate inferior to actual one given back by Fee Estimator, use it to compute new fee... + let new_fee = if $old_feerate < $fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) { + let mut value = $amount; + if subtract_high_prio_fee!(self, $fee_estimator, value, $predicted_weight, used_feerate) { + // Overflow check is done in subtract_high_prio_fee + $amount - value + } else { + log_trace!(self, "Can't new-estimation bump new claiming tx, amount {} is too small", $amount); + return None; + } + // ...else just increase the previous feerate by 25% (because that's a nice number) + } else { + let fee = $old_feerate * $predicted_weight / 750; + if $amount <= fee { + log_trace!(self, "Can't 25% bump new claiming tx, amount {} is too small", $amount); + return None; + } + fee + }; + + let previous_fee = $old_feerate * $predicted_weight / 1000; + let min_relay_fee = MIN_RELAY_FEE_SAT_PER_1000_WEIGHT * $predicted_weight / 1000; + // BIP 125 Opt-in Full Replace-by-Fee Signaling + // * 3. The replacement transaction pays an absolute fee of at least the sum paid by the original transactions. + // * 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. + let new_fee = if new_fee < previous_fee + min_relay_fee { + new_fee + previous_fee + min_relay_fee - new_fee + } else { + new_fee + }; + Some((new_fee, new_fee * 1000 / $predicted_weight)) + } + } + } + + let new_timer = Self::get_height_timer(height, cached_claim_datas.soonest_timelock); + let mut inputs_witnesses_weight = 0; + let mut amt = 0; + for per_outp_material in cached_claim_datas.per_input_material.values() { + match per_outp_material { + &InputMaterial::Revoked { ref script, ref is_htlc, ref amount, .. } => { + inputs_witnesses_weight += Self::get_witnesses_weight(if !is_htlc { &[InputDescriptors::RevokedOutput] } else if script.len() == OFFERED_HTLC_SCRIPT_WEIGHT { &[InputDescriptors::RevokedOfferedHTLC] } else if script.len() == ACCEPTED_HTLC_SCRIPT_WEIGHT { &[InputDescriptors::RevokedReceivedHTLC] } else { &[] }); + amt += *amount; + }, + &InputMaterial::RemoteHTLC { ref preimage, ref amount, .. } => { + inputs_witnesses_weight += Self::get_witnesses_weight(if preimage.is_some() { &[InputDescriptors::OfferedHTLC] } else { &[InputDescriptors::ReceivedHTLC] }); + amt += *amount; + }, + &InputMaterial::LocalHTLC { .. } => { return None; } + } + } + + let predicted_weight = bumped_tx.get_weight() + inputs_witnesses_weight; + let new_feerate; + if let Some((new_fee, feerate)) = RBF_bump!(amt, cached_claim_datas.feerate_previous, fee_estimator, predicted_weight as u64) { + // If new computed fee is superior at the whole claimable amount burn all in fees + if new_fee > amt { + bumped_tx.output[0].value = 0; + } else { + bumped_tx.output[0].value = amt - new_fee; + } + new_feerate = feerate; + } else { + return None; + } + assert!(new_feerate != 0); + + for (i, (outp, per_outp_material)) in cached_claim_datas.per_input_material.iter().enumerate() { + match per_outp_material { + &InputMaterial::Revoked { ref script, ref pubkey, ref key, ref is_htlc, ref amount } => { + let sighash_parts = bip143::SighashComponents::new(&bumped_tx); + let sighash = hash_to_message!(&sighash_parts.sighash_all(&bumped_tx.input[i], &script, *amount)[..]); + let sig = self.secp_ctx.sign(&sighash, &key); + bumped_tx.input[i].witness.push(sig.serialize_der().to_vec()); + bumped_tx.input[i].witness[0].push(SigHashType::All as u8); + if *is_htlc { + bumped_tx.input[i].witness.push(pubkey.unwrap().clone().serialize().to_vec()); + } else { + bumped_tx.input[i].witness.push(vec!(1)); + } + bumped_tx.input[i].witness.push(script.clone().into_bytes()); + log_trace!(self, "Going to broadcast bumped Penalty Transaction {} claiming revoked {} output {} from {} with new feerate {}", bumped_tx.txid(), if !is_htlc { "to_local" } else if script.len() == OFFERED_HTLC_SCRIPT_WEIGHT { "offered" } else if script.len() == ACCEPTED_HTLC_SCRIPT_WEIGHT { "received" } else { "" }, outp.vout, outp.txid, new_feerate); + }, + &InputMaterial::RemoteHTLC { ref script, ref key, ref preimage, ref amount, ref locktime } => { + if !preimage.is_some() { bumped_tx.lock_time = *locktime }; + let sighash_parts = bip143::SighashComponents::new(&bumped_tx); + let sighash = hash_to_message!(&sighash_parts.sighash_all(&bumped_tx.input[i], &script, *amount)[..]); + let sig = self.secp_ctx.sign(&sighash, &key); + bumped_tx.input[i].witness.push(sig.serialize_der().to_vec()); + bumped_tx.input[i].witness[0].push(SigHashType::All as u8); + if let &Some(preimage) = preimage { + bumped_tx.input[i].witness.push(preimage.clone().0.to_vec()); + } else { + bumped_tx.input[i].witness.push(vec![0]); + } + bumped_tx.input[i].witness.push(script.clone().into_bytes()); + log_trace!(self, "Going to broadcast bumped Claim Transaction {} claiming remote {} htlc output {} from {} with new feerate {}", bumped_tx.txid(), if preimage.is_some() { "offered" } else { "received" }, outp.vout, outp.txid, new_feerate); + }, + &InputMaterial::LocalHTLC { .. } => { + //TODO : Given that Local Commitment Transaction and HTLC-Timeout/HTLC-Success are counter-signed by peer, we can't + // RBF them. Need a Lightning specs change and package relay modification : + // https://lists.linuxfoundation.org/pipermail/bitcoin-dev/2018-November/016518.html + return None; + } + } + } + assert!(predicted_weight >= bumped_tx.get_weight()); + Some((new_timer, new_feerate, bumped_tx)) + } } const MAX_ALLOC_SIZE: usize = 64*1024; @@ -2694,61 +3156,19 @@ impl ReadableArgs> for (Sha256dHash, ChannelM _ => return Err(DecodeError::InvalidValue), }; - let our_claim_txn_waiting_first_conf_len: u64 = Readable::read(reader)?; - let mut our_claim_txn_waiting_first_conf = HashMap::with_capacity(cmp::min(our_claim_txn_waiting_first_conf_len as usize, MAX_ALLOC_SIZE / 128)); - for _ in 0..our_claim_txn_waiting_first_conf_len { + let pending_claim_requests_len: u64 = Readable::read(reader)?; + let mut pending_claim_requests = HashMap::with_capacity(cmp::min(pending_claim_requests_len as usize, MAX_ALLOC_SIZE / 128)); + for _ in 0..pending_claim_requests_len { + pending_claim_requests.insert(Readable::read(reader)?, Readable::read(reader)?); + } + + let claimable_outpoints_len: u64 = Readable::read(reader)?; + let mut claimable_outpoints = HashMap::with_capacity(cmp::min(pending_claim_requests_len as usize, MAX_ALLOC_SIZE / 128)); + for _ in 0..claimable_outpoints_len { let outpoint = Readable::read(reader)?; - let height_target = Readable::read(reader)?; - let tx_material = match >::read(reader)? { - 0 => { - let script = Readable::read(reader)?; - let pubkey = Readable::read(reader)?; - let key = Readable::read(reader)?; - let is_htlc = match >::read(reader)? { - 0 => true, - 1 => false, - _ => return Err(DecodeError::InvalidValue), - }; - let amount = Readable::read(reader)?; - TxMaterial::Revoked { - script, - pubkey, - key, - is_htlc, - amount - } - }, - 1 => { - let script = Readable::read(reader)?; - let key = Readable::read(reader)?; - let preimage = Readable::read(reader)?; - let amount = Readable::read(reader)?; - TxMaterial::RemoteHTLC { - script, - key, - preimage, - amount - } - }, - 2 => { - let script = Readable::read(reader)?; - let their_sig = Readable::read(reader)?; - let our_sig = Readable::read(reader)?; - let preimage = Readable::read(reader)?; - let amount = Readable::read(reader)?; - TxMaterial::LocalHTLC { - script, - sigs: (their_sig, our_sig), - preimage, - amount - } - } - _ => return Err(DecodeError::InvalidValue), - }; - let last_fee = Readable::read(reader)?; - let timelock_expiration = Readable::read(reader)?; + let ancestor_claim_txid = Readable::read(reader)?; let height = Readable::read(reader)?; - our_claim_txn_waiting_first_conf.insert(outpoint, (height_target, tx_material, last_fee, timelock_expiration, height)); + claimable_outpoints.insert(outpoint, (ancestor_claim_txid, height)); } let waiting_threshold_conf_len: u64 = Readable::read(reader)?; @@ -2760,9 +3180,9 @@ impl ReadableArgs> for (Sha256dHash, ChannelM for _ in 0..events_len { let ev = match >::read(reader)? { 0 => { - let outpoint = Readable::read(reader)?; + let claim_request = Readable::read(reader)?; OnchainEvent::Claim { - outpoint + claim_request } }, 1 => { @@ -2772,6 +3192,14 @@ impl ReadableArgs> for (Sha256dHash, ChannelM htlc_update: (htlc_source, hash) } }, + 2 => { + let outpoint = Readable::read(reader)?; + let input_material = Readable::read(reader)?; + OnchainEvent::ContentiousOutpoint { + outpoint, + input_material + } + } _ => return Err(DecodeError::InvalidValue), }; events.push(ev); @@ -2804,7 +3232,9 @@ impl ReadableArgs> for (Sha256dHash, ChannelM destination_script, to_remote_rescue, - our_claim_txn_waiting_first_conf, + pending_claim_requests, + + claimable_outpoints, onchain_events_waiting_threshold_conf,