X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fchain%2Fonchaintx.rs;h=5daa2463de99ec0d129bd3e28f0cf6a11b161e9c;hb=eea19de198a359d9014d704baaffc70bdb93f4f7;hp=58ad449334b98db717880ea915c1b571087c6726;hpb=d5cbc6c261db73f1712512be50b82114eae76f62;p=rust-lightning diff --git a/lightning/src/chain/onchaintx.rs b/lightning/src/chain/onchaintx.rs index 58ad4493..5daa2463 100644 --- a/lightning/src/chain/onchaintx.rs +++ b/lightning/src/chain/onchaintx.rs @@ -12,35 +12,26 @@ //! OnchainTxHandler objects are fully-part of ChannelMonitor and encapsulates all //! building, tracking, bumping and notifications functions. -#[cfg(anchors)] use bitcoin::PackedLockTime; use bitcoin::blockdata::transaction::Transaction; use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint; use bitcoin::blockdata::script::Script; -use bitcoin::hashes::Hash; -#[cfg(anchors)] -use bitcoin::hashes::HashEngine; -#[cfg(anchors)] +use bitcoin::hashes::{Hash, HashEngine}; use bitcoin::hashes::sha256::Hash as Sha256; use bitcoin::hash_types::{Txid, BlockHash}; use bitcoin::secp256k1::{Secp256k1, ecdsa::Signature}; use bitcoin::secp256k1; +use crate::chain::chaininterface::compute_feerate_sat_per_1000_weight; use crate::sign::{ChannelSigner, EntropySource, SignerProvider}; use crate::ln::msgs::DecodeError; use crate::ln::PaymentPreimage; -#[cfg(anchors)] -use crate::ln::chan_utils::{self, HTLCOutputInCommitment}; -use crate::ln::chan_utils::{ChannelTransactionParameters, HolderCommitmentTransaction}; +use crate::ln::chan_utils::{self, ChannelTransactionParameters, HTLCOutputInCommitment, HolderCommitmentTransaction}; use crate::chain::ClaimId; -#[cfg(anchors)] -use crate::chain::chaininterface::ConfirmationTarget; -use crate::chain::chaininterface::{FeeEstimator, BroadcasterInterface, LowerBoundedFeeEstimator}; +use crate::chain::chaininterface::{ConfirmationTarget, FeeEstimator, BroadcasterInterface, LowerBoundedFeeEstimator}; use crate::chain::channelmonitor::{ANTI_REORG_DELAY, CLTV_SHARED_CLAIM_BUFFER}; use crate::sign::WriteableEcdsaChannelSigner; -#[cfg(anchors)] -use crate::chain::package::PackageSolvingData; -use crate::chain::package::PackageTemplate; +use crate::chain::package::{PackageSolvingData, PackageTemplate}; use crate::util::logger::Logger; use crate::util::ser::{Readable, ReadableArgs, MaybeReadable, UpgradableRequired, Writer, Writeable, VecWriter}; @@ -50,8 +41,8 @@ use alloc::collections::BTreeMap; use core::cmp; use core::ops::Deref; use core::mem::replace; -#[cfg(anchors)] use core::mem::swap; +use crate::ln::features::ChannelTypeFeatures; const MAX_ALLOC_SIZE: usize = 64*1024; @@ -59,7 +50,7 @@ const MAX_ALLOC_SIZE: usize = 64*1024; /// transaction causing it. /// /// Used to determine when the on-chain event can be considered safe from a chain reorganization. -#[derive(PartialEq, Eq)] +#[derive(Clone, PartialEq, Eq)] struct OnchainEventEntry { txid: Txid, height: u32, @@ -79,7 +70,7 @@ impl OnchainEventEntry { /// Events for claims the [`OnchainTxHandler`] has generated. Once the events are considered safe /// from a chain reorg, the [`OnchainTxHandler`] will act accordingly. -#[derive(PartialEq, Eq)] +#[derive(Clone, PartialEq, Eq)] enum OnchainEvent { /// A pending request has been claimed by a transaction spending the exact same set of outpoints /// as the request. This claim can either be ours or from the counterparty. Once the claiming @@ -180,8 +171,8 @@ impl Writeable for Option>> { } } -#[cfg(anchors)] /// The claim commonly referred to as the pre-signed second-stage HTLC transaction. +#[derive(Clone, PartialEq, Eq)] pub(crate) struct ExternalHTLCClaim { pub(crate) commitment_txid: Txid, pub(crate) per_commitment_number: u64, @@ -192,7 +183,7 @@ pub(crate) struct ExternalHTLCClaim { // Represents the different types of claims for which events are yielded externally to satisfy said // claims. -#[cfg(anchors)] +#[derive(Clone, PartialEq, Eq)] pub(crate) enum ClaimEvent { /// Event yielded to signal that the commitment transaction fee must be bumped to claim any /// encumbered funds and proceed to HTLC resolution, if any HTLCs exist. @@ -215,7 +206,6 @@ pub(crate) enum ClaimEvent { pub(crate) enum OnchainClaim { /// A finalized transaction pending confirmation spending the output to claim. Tx(Transaction), - #[cfg(anchors)] /// An event yielded externally to signal additional inputs must be added to a transaction /// pending confirmation spending the output to claim. Event(ClaimEvent), @@ -223,6 +213,7 @@ pub(crate) enum OnchainClaim { /// OnchainTxHandler receives claiming requests, aggregates them if it's sound, broadcast and /// do RBF bumping if possible. +#[derive(Clone)] pub struct OnchainTxHandler { destination_script: Script, holder_commitment: HolderCommitmentTransaction, @@ -262,7 +253,6 @@ pub struct OnchainTxHandler { // - A channel has been force closed by broadcasting the holder's latest commitment transaction // - A block being connected/disconnected // - Learning the preimage for an HTLC we can claim onchain - #[cfg(anchors)] pending_claim_events: Vec<(ClaimId, ClaimEvent)>, // Used to link outpoints claimed in a connected block to a pending claim request. The keys @@ -439,7 +429,6 @@ impl<'a, 'b, ES: EntropySource, SP: SignerProvider> ReadableArgs<(&'a ES, &'b SP locktimed_packages, pending_claim_requests, onchain_events_awaiting_threshold_conf, - #[cfg(anchors)] pending_claim_events: Vec::new(), secp_ctx, }) @@ -460,7 +449,6 @@ impl OnchainTxHandler claimable_outpoints: HashMap::new(), locktimed_packages: BTreeMap::new(), onchain_events_awaiting_threshold_conf: Vec::new(), - #[cfg(anchors)] pending_claim_events: Vec::new(), secp_ctx, } @@ -474,7 +462,6 @@ impl OnchainTxHandler self.holder_commitment.to_broadcaster_value_sat() } - #[cfg(anchors)] pub(crate) fn get_and_clear_pending_claim_events(&mut self) -> Vec<(ClaimId, ClaimEvent)> { let mut events = Vec::new(); swap(&mut events, &mut self.pending_claim_events); @@ -515,7 +502,6 @@ impl OnchainTxHandler log_info!(logger, "{} onchain {}", log_start, log_tx!(tx)); broadcaster.broadcast_transactions(&[&tx]); }, - #[cfg(anchors)] OnchainClaim::Event(event) => { let log_start = if bumped_feerate { "Yielding fee-bumped" } else { "Replaying" }; log_info!(logger, "{} onchain event to spend inputs {:?}", log_start, @@ -592,25 +578,22 @@ impl OnchainTxHandler // didn't receive confirmation of it before, or not enough reorg-safe depth on top of it). let new_timer = cached_request.get_height_timer(cur_height); if cached_request.is_malleable() { - #[cfg(anchors)] - { // Attributes are not allowed on if expressions on our current MSRV of 1.41. - if cached_request.requires_external_funding() { - let target_feerate_sat_per_1000_weight = cached_request.compute_package_feerate( - fee_estimator, ConfirmationTarget::HighPriority, force_feerate_bump - ); - if let Some(htlcs) = cached_request.construct_malleable_package_with_external_funding(self) { - return Some(( - new_timer, - target_feerate_sat_per_1000_weight as u64, - OnchainClaim::Event(ClaimEvent::BumpHTLC { - target_feerate_sat_per_1000_weight, - htlcs, - tx_lock_time: PackedLockTime(cached_request.package_locktime(cur_height)), - }), - )); - } else { - return None; - } + if cached_request.requires_external_funding() { + let target_feerate_sat_per_1000_weight = cached_request.compute_package_feerate( + fee_estimator, ConfirmationTarget::HighPriority, force_feerate_bump + ); + if let Some(htlcs) = cached_request.construct_malleable_package_with_external_funding(self) { + return Some(( + new_timer, + target_feerate_sat_per_1000_weight as u64, + OnchainClaim::Event(ClaimEvent::BumpHTLC { + target_feerate_sat_per_1000_weight, + htlcs, + tx_lock_time: PackedLockTime(cached_request.package_locktime(cur_height)), + }), + )); + } else { + return None; } } @@ -632,9 +615,6 @@ impl OnchainTxHandler // Untractable packages cannot have their fees bumped through Replace-By-Fee. Some // packages may support fee bumping through Child-Pays-For-Parent, indicated by those // which require external funding. - #[cfg(not(anchors))] - let inputs = cached_request.inputs(); - #[cfg(anchors)] let mut inputs = cached_request.inputs(); debug_assert_eq!(inputs.len(), 1); let tx = match cached_request.finalize_untractable_package(self, logger) { @@ -644,13 +624,28 @@ impl OnchainTxHandler if !cached_request.requires_external_funding() { return Some((new_timer, 0, OnchainClaim::Tx(tx))); } - #[cfg(anchors)] return inputs.find_map(|input| match input { // Commitment inputs with anchors support are the only untractable inputs supported // thus far that require external funding. - PackageSolvingData::HolderFundingOutput(..) => { + PackageSolvingData::HolderFundingOutput(output) => { debug_assert_eq!(tx.txid(), self.holder_commitment.trust().txid(), "Holder commitment transaction mismatch"); + + let conf_target = ConfirmationTarget::HighPriority; + let package_target_feerate_sat_per_1000_weight = cached_request + .compute_package_feerate(fee_estimator, conf_target, force_feerate_bump); + if let Some(input_amount_sat) = output.funding_amount { + let fee_sat = input_amount_sat - tx.output.iter().map(|output| output.value).sum::(); + let commitment_tx_feerate_sat_per_1000_weight = + compute_feerate_sat_per_1000_weight(fee_sat, tx.weight() as u64); + if commitment_tx_feerate_sat_per_1000_weight >= package_target_feerate_sat_per_1000_weight { + log_debug!(logger, "Pre-signed {} already has feerate {} sat/kW above required {} sat/kW", + log_tx!(tx), commitment_tx_feerate_sat_per_1000_weight, + package_target_feerate_sat_per_1000_weight); + return Some((new_timer, 0, OnchainClaim::Tx(tx.clone()))); + } + } + // We'll locate an anchor output we can spend within the commitment transaction. let funding_pubkey = &self.channel_transaction_parameters.holder_pubkeys.funding_pubkey; match chan_utils::get_anchor_output(&tx, funding_pubkey) { @@ -658,9 +653,6 @@ impl OnchainTxHandler Some((idx, _)) => { // TODO: Use a lower confirmation target when both our and the // counterparty's latest commitment don't have any HTLCs present. - let conf_target = ConfirmationTarget::HighPriority; - let package_target_feerate_sat_per_1000_weight = cached_request - .compute_package_feerate(fee_estimator, conf_target, force_feerate_bump); Some(( new_timer, package_target_feerate_sat_per_1000_weight as u64, @@ -764,13 +756,15 @@ impl OnchainTxHandler ) { req.set_timer(new_timer); req.set_feerate(new_feerate); + // Once a pending claim has an id assigned, it remains fixed until the claim is + // satisfied, regardless of whether the claim switches between different variants of + // `OnchainClaim`. let claim_id = match claim { OnchainClaim::Tx(tx) => { log_info!(logger, "Broadcasting onchain {}", log_tx!(tx)); broadcaster.broadcast_transactions(&[&tx]); ClaimId(tx.txid().into_inner()) }, - #[cfg(anchors)] OnchainClaim::Event(claim_event) => { log_info!(logger, "Yielding onchain event to spend inputs {:?}", req.outpoints()); let claim_id = match claim_event { @@ -885,14 +879,12 @@ impl OnchainTxHandler // input(s) that already have a confirmed spend. If such spend is // reorged out of the chain, then we'll attempt to re-spend the // inputs once we see it. - #[cfg(anchors)] { - #[cfg(debug_assertions)] { - let existing = self.pending_claim_events.iter() - .filter(|entry| entry.0 == *claim_id).count(); - assert!(existing == 0 || existing == 1); - } - self.pending_claim_events.retain(|entry| entry.0 != *claim_id); + #[cfg(debug_assertions)] { + let existing = self.pending_claim_events.iter() + .filter(|entry| entry.0 == *claim_id).count(); + assert!(existing == 0 || existing == 1); } + self.pending_claim_events.retain(|entry| entry.0 != *claim_id); } } break; //No need to iterate further, either tx is our or their @@ -929,14 +921,12 @@ impl OnchainTxHandler outpoint, log_bytes!(claim_id.0)); self.claimable_outpoints.remove(outpoint); } - #[cfg(anchors)] { - #[cfg(debug_assertions)] { - let num_existing = self.pending_claim_events.iter() - .filter(|entry| entry.0 == claim_id).count(); - assert!(num_existing == 0 || num_existing == 1); - } - self.pending_claim_events.retain(|(id, _)| *id != claim_id); + #[cfg(debug_assertions)] { + let num_existing = self.pending_claim_events.iter() + .filter(|entry| entry.0 == claim_id).count(); + assert!(num_existing == 0 || num_existing == 1); } + self.pending_claim_events.retain(|(id, _)| *id != claim_id); } }, OnchainEvent::ContentiousOutpoint { package } => { @@ -968,7 +958,6 @@ impl OnchainTxHandler log_info!(logger, "Broadcasting RBF-bumped onchain {}", log_tx!(bump_tx)); broadcaster.broadcast_transactions(&[&bump_tx]); }, - #[cfg(anchors)] OnchainClaim::Event(claim_event) => { log_info!(logger, "Yielding RBF-bumped onchain event to spend inputs {:?}", request.outpoints()); #[cfg(debug_assertions)] { @@ -1054,7 +1043,6 @@ impl OnchainTxHandler log_info!(logger, "Broadcasting onchain {}", log_tx!(bump_tx)); broadcaster.broadcast_transactions(&[&bump_tx]); }, - #[cfg(anchors)] OnchainClaim::Event(claim_event) => { log_info!(logger, "Yielding onchain event after reorg to spend inputs {:?}", request.outpoints()); #[cfg(debug_assertions)] { @@ -1135,8 +1123,12 @@ impl OnchainTxHandler ret } + pub(crate) fn get_unsigned_holder_commitment_tx(&self) -> &Transaction { + &self.holder_commitment.trust().built_transaction().transaction + } + //TODO: getting lastest holder transactions should be infallible and result in us "force-closing the channel", but we may - // have empty holder commitment transaction if a ChannelMonitor is asked to force-close just after Channel::get_outbound_funding_created, + // have empty holder commitment transaction if a ChannelMonitor is asked to force-close just after OutboundV1Channel::get_funding_created, // before providing a initial commitment transaction. For outbound channel, init ChannelMonitor at Channel::funding_signed, there is nothing // to monitor before. pub(crate) fn get_fully_signed_holder_tx(&mut self, funding_redeemscript: &Script) -> Transaction { @@ -1184,7 +1176,6 @@ impl OnchainTxHandler htlc_tx } - #[cfg(anchors)] pub(crate) fn generate_external_htlc_claim( &self, outp: &::bitcoin::OutPoint, preimage: &Option ) -> Option { @@ -1215,8 +1206,8 @@ impl OnchainTxHandler .or_else(|| self.prev_holder_commitment.as_ref().map(|c| find_htlc(c)).flatten()) } - pub(crate) fn opt_anchors(&self) -> bool { - self.channel_transaction_parameters.opt_anchors.is_some() + pub(crate) fn channel_type_features(&self) -> &ChannelTypeFeatures { + &self.channel_transaction_parameters.channel_type_features } #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]