]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/events/bump_transaction.rs
Support failing blinded non-intro HTLCs after RAA processing.
[rust-lightning] / lightning / src / events / bump_transaction.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
8 // licenses.
9
10 //! Utilities for bumping transactions originating from [`Event`]s.
11 //!
12 //! [`Event`]: crate::events::Event
13
14 use alloc::collections::BTreeMap;
15 use core::ops::Deref;
16
17 use crate::chain::chaininterface::{BroadcasterInterface, fee_for_weight};
18 use crate::chain::ClaimId;
19 use crate::io_extras::sink;
20 use crate::ln::channel::ANCHOR_OUTPUT_VALUE_SATOSHI;
21 use crate::ln::chan_utils;
22 use crate::ln::chan_utils::{
23         ANCHOR_INPUT_WITNESS_WEIGHT, HTLC_SUCCESS_INPUT_ANCHOR_WITNESS_WEIGHT,
24         HTLC_TIMEOUT_INPUT_ANCHOR_WITNESS_WEIGHT, HTLCOutputInCommitment
25 };
26 use crate::prelude::*;
27 use crate::sign::{
28         ChannelDerivationParameters, HTLCDescriptor, SignerProvider, P2WPKH_WITNESS_WEIGHT
29 };
30 use crate::sign::ecdsa::{EcdsaChannelSigner, WriteableEcdsaChannelSigner};
31 use crate::sync::Mutex;
32 use crate::util::logger::Logger;
33
34 use bitcoin::{OutPoint, PubkeyHash, Sequence, ScriptBuf, Transaction, TxIn, TxOut, Witness, WPubkeyHash};
35 use bitcoin::blockdata::constants::WITNESS_SCALE_FACTOR;
36 use bitcoin::blockdata::locktime::absolute::LockTime;
37 use bitcoin::consensus::Encodable;
38 use bitcoin::secp256k1;
39 use bitcoin::secp256k1::Secp256k1;
40 use bitcoin::secp256k1::ecdsa::Signature;
41
42 const EMPTY_SCRIPT_SIG_WEIGHT: u64 = 1 /* empty script_sig */ * WITNESS_SCALE_FACTOR as u64;
43
44 const BASE_INPUT_SIZE: u64 = 32 /* txid */ + 4 /* vout */ + 4 /* sequence */;
45
46 const BASE_INPUT_WEIGHT: u64 = BASE_INPUT_SIZE * WITNESS_SCALE_FACTOR as u64;
47
48 /// A descriptor used to sign for a commitment transaction's anchor output.
49 #[derive(Clone, Debug, PartialEq, Eq)]
50 pub struct AnchorDescriptor {
51         /// The parameters required to derive the signer for the anchor input.
52         pub channel_derivation_parameters: ChannelDerivationParameters,
53         /// The transaction input's outpoint corresponding to the commitment transaction's anchor
54         /// output.
55         pub outpoint: OutPoint,
56 }
57
58 impl AnchorDescriptor {
59         /// Returns the UTXO to be spent by the anchor input, which can be obtained via
60         /// [`Self::unsigned_tx_input`].
61         pub fn previous_utxo(&self) -> TxOut {
62                 TxOut {
63                         script_pubkey: self.witness_script().to_v0_p2wsh(),
64                         value: ANCHOR_OUTPUT_VALUE_SATOSHI,
65                 }
66         }
67
68         /// Returns the unsigned transaction input spending the anchor output in the commitment
69         /// transaction.
70         pub fn unsigned_tx_input(&self) -> TxIn {
71                 TxIn {
72                         previous_output: self.outpoint.clone(),
73                         script_sig: ScriptBuf::new(),
74                         sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
75                         witness: Witness::new(),
76                 }
77         }
78
79         /// Returns the witness script of the anchor output in the commitment transaction.
80         pub fn witness_script(&self) -> ScriptBuf {
81                 let channel_params = self.channel_derivation_parameters.transaction_parameters.as_holder_broadcastable();
82                 chan_utils::get_anchor_redeemscript(&channel_params.broadcaster_pubkeys().funding_pubkey)
83         }
84
85         /// Returns the fully signed witness required to spend the anchor output in the commitment
86         /// transaction.
87         pub fn tx_input_witness(&self, signature: &Signature) -> Witness {
88                 let channel_params = self.channel_derivation_parameters.transaction_parameters.as_holder_broadcastable();
89                 chan_utils::build_anchor_input_witness(&channel_params.broadcaster_pubkeys().funding_pubkey, signature)
90         }
91
92         /// Derives the channel signer required to sign the anchor input.
93         pub fn derive_channel_signer<S: WriteableEcdsaChannelSigner, SP: Deref>(&self, signer_provider: &SP) -> S
94         where
95                 SP::Target: SignerProvider<EcdsaSigner= S>
96         {
97                 let mut signer = signer_provider.derive_channel_signer(
98                         self.channel_derivation_parameters.value_satoshis,
99                         self.channel_derivation_parameters.keys_id,
100                 );
101                 signer.provide_channel_parameters(&self.channel_derivation_parameters.transaction_parameters);
102                 signer
103         }
104 }
105
106 /// Represents the different types of transactions, originating from LDK, to be bumped.
107 #[derive(Clone, Debug, PartialEq, Eq)]
108 pub enum BumpTransactionEvent {
109         /// Indicates that a channel featuring anchor outputs is to be closed by broadcasting the local
110         /// commitment transaction. Since commitment transactions have a static feerate pre-agreed upon,
111         /// they may need additional fees to be attached through a child transaction using the popular
112         /// [Child-Pays-For-Parent](https://bitcoinops.org/en/topics/cpfp) fee bumping technique. This
113         /// child transaction must include the anchor input described within `anchor_descriptor` along
114         /// with additional inputs to meet the target feerate. Failure to meet the target feerate
115         /// decreases the confirmation odds of the transaction package (which includes the commitment
116         /// and child anchor transactions), possibly resulting in a loss of funds. Once the transaction
117         /// is constructed, it must be fully signed for and broadcast by the consumer of the event
118         /// along with the `commitment_tx` enclosed. Note that the `commitment_tx` must always be
119         /// broadcast first, as the child anchor transaction depends on it.
120         ///
121         /// The consumer should be able to sign for any of the additional inputs included within the
122         /// child anchor transaction. To sign its anchor input, an [`EcdsaChannelSigner`] should be
123         /// re-derived through [`AnchorDescriptor::derive_channel_signer`]. The anchor input signature
124         /// can be computed with [`EcdsaChannelSigner::sign_holder_anchor_input`], which can then be
125         /// provided to [`build_anchor_input_witness`] along with the `funding_pubkey` to obtain the
126         /// full witness required to spend.
127         ///
128         /// It is possible to receive more than one instance of this event if a valid child anchor
129         /// transaction is never broadcast or is but not with a sufficient fee to be mined. Care should
130         /// be taken by the consumer of the event to ensure any future iterations of the child anchor
131         /// transaction adhere to the [Replace-By-Fee
132         /// rules](https://github.com/bitcoin/bitcoin/blob/master/doc/policy/mempool-replacements.md)
133         /// for fee bumps to be accepted into the mempool, and eventually the chain. As the frequency of
134         /// these events is not user-controlled, users may ignore/drop the event if they are no longer
135         /// able to commit external confirmed funds to the child anchor transaction.
136         ///
137         /// The set of `pending_htlcs` on the commitment transaction to be broadcast can be inspected to
138         /// determine whether a significant portion of the channel's funds are allocated to HTLCs,
139         /// enabling users to make their own decisions regarding the importance of the commitment
140         /// transaction's confirmation. Note that this is not required, but simply exists as an option
141         /// for users to override LDK's behavior. On commitments with no HTLCs (indicated by those with
142         /// an empty `pending_htlcs`), confirmation of the commitment transaction can be considered to
143         /// be not urgent.
144         ///
145         /// [`EcdsaChannelSigner`]: crate::sign::ecdsa::EcdsaChannelSigner
146         /// [`EcdsaChannelSigner::sign_holder_anchor_input`]: crate::sign::ecdsa::EcdsaChannelSigner::sign_holder_anchor_input
147         /// [`build_anchor_input_witness`]: crate::ln::chan_utils::build_anchor_input_witness
148         ChannelClose {
149                 /// The unique identifier for the claim of the anchor output in the commitment transaction.
150                 ///
151                 /// The identifier must map to the set of external UTXOs assigned to the claim, such that
152                 /// they can be reused when a new claim with the same identifier needs to be made, resulting
153                 /// in a fee-bumping attempt.
154                 claim_id: ClaimId,
155                 /// The target feerate that the transaction package, which consists of the commitment
156                 /// transaction and the to-be-crafted child anchor transaction, must meet.
157                 package_target_feerate_sat_per_1000_weight: u32,
158                 /// The channel's commitment transaction to bump the fee of. This transaction should be
159                 /// broadcast along with the anchor transaction constructed as a result of consuming this
160                 /// event.
161                 commitment_tx: Transaction,
162                 /// The absolute fee in satoshis of the commitment transaction. This can be used along the
163                 /// with weight of the commitment transaction to determine its feerate.
164                 commitment_tx_fee_satoshis: u64,
165                 /// The descriptor to sign the anchor input of the anchor transaction constructed as a
166                 /// result of consuming this event.
167                 anchor_descriptor: AnchorDescriptor,
168                 /// The set of pending HTLCs on the commitment transaction that need to be resolved once the
169                 /// commitment transaction confirms.
170                 pending_htlcs: Vec<HTLCOutputInCommitment>,
171         },
172         /// Indicates that a channel featuring anchor outputs has unilaterally closed on-chain by a
173         /// holder commitment transaction and its HTLC(s) need to be resolved on-chain. With the
174         /// zero-HTLC-transaction-fee variant of anchor outputs, the pre-signed HTLC
175         /// transactions have a zero fee, thus requiring additional inputs and/or outputs to be attached
176         /// for a timely confirmation within the chain. These additional inputs and/or outputs must be
177         /// appended to the resulting HTLC transaction to meet the target feerate. Failure to meet the
178         /// target feerate decreases the confirmation odds of the transaction, possibly resulting in a
179         /// loss of funds. Once the transaction meets the target feerate, it must be signed for and
180         /// broadcast by the consumer of the event.
181         ///
182         /// The consumer should be able to sign for any of the non-HTLC inputs added to the resulting
183         /// HTLC transaction. To sign HTLC inputs, an [`EcdsaChannelSigner`] should be re-derived
184         /// through [`HTLCDescriptor::derive_channel_signer`]. Each HTLC input's signature can be
185         /// computed with [`EcdsaChannelSigner::sign_holder_htlc_transaction`], which can then be
186         /// provided to [`HTLCDescriptor::tx_input_witness`] to obtain the fully signed witness required
187         /// to spend.
188         ///
189         /// It is possible to receive more than one instance of this event if a valid HTLC transaction
190         /// is never broadcast or is but not with a sufficient fee to be mined. Care should be taken by
191         /// the consumer of the event to ensure any future iterations of the HTLC transaction adhere to
192         /// the [Replace-By-Fee
193         /// rules](https://github.com/bitcoin/bitcoin/blob/master/doc/policy/mempool-replacements.md)
194         /// for fee bumps to be accepted into the mempool, and eventually the chain. As the frequency of
195         /// these events is not user-controlled, users may ignore/drop the event if either they are no
196         /// longer able to commit external confirmed funds to the HTLC transaction or the fee committed
197         /// to the HTLC transaction is greater in value than the HTLCs being claimed.
198         ///
199         /// [`EcdsaChannelSigner`]: crate::sign::ecdsa::EcdsaChannelSigner
200         /// [`EcdsaChannelSigner::sign_holder_htlc_transaction`]: crate::sign::ecdsa::EcdsaChannelSigner::sign_holder_htlc_transaction
201         HTLCResolution {
202                 /// The unique identifier for the claim of the HTLCs in the confirmed commitment
203                 /// transaction.
204                 ///
205                 /// The identifier must map to the set of external UTXOs assigned to the claim, such that
206                 /// they can be reused when a new claim with the same identifier needs to be made, resulting
207                 /// in a fee-bumping attempt.
208                 claim_id: ClaimId,
209                 /// The target feerate that the resulting HTLC transaction must meet.
210                 target_feerate_sat_per_1000_weight: u32,
211                 /// The set of pending HTLCs on the confirmed commitment that need to be claimed, preferably
212                 /// by the same transaction.
213                 htlc_descriptors: Vec<HTLCDescriptor>,
214                 /// The locktime required for the resulting HTLC transaction.
215                 tx_lock_time: LockTime,
216         },
217 }
218
219 /// An input that must be included in a transaction when performing coin selection through
220 /// [`CoinSelectionSource::select_confirmed_utxos`]. It is guaranteed to be a SegWit input, so it
221 /// must have an empty [`TxIn::script_sig`] when spent.
222 #[derive(Clone, Debug, Hash, PartialOrd, Ord, PartialEq, Eq)]
223 pub struct Input {
224         /// The unique identifier of the input.
225         pub outpoint: OutPoint,
226         /// The UTXO being spent by the input.
227         pub previous_utxo: TxOut,
228         /// The upper-bound weight consumed by the input's full [`TxIn::script_sig`] and
229         /// [`TxIn::witness`], each with their lengths included, required to satisfy the output's
230         /// script.
231         pub satisfaction_weight: u64,
232 }
233
234 /// An unspent transaction output that is available to spend resulting from a successful
235 /// [`CoinSelection`] attempt.
236 #[derive(Clone, Debug, Hash, PartialOrd, Ord, PartialEq, Eq)]
237 pub struct Utxo {
238         /// The unique identifier of the output.
239         pub outpoint: OutPoint,
240         /// The output to spend.
241         pub output: TxOut,
242         /// The upper-bound weight consumed by the input's full [`TxIn::script_sig`] and [`TxIn::witness`], each
243         /// with their lengths included, required to satisfy the output's script. The weight consumed by
244         /// the input's `script_sig` must account for [`WITNESS_SCALE_FACTOR`].
245         pub satisfaction_weight: u64,
246 }
247
248 impl Utxo {
249         /// Returns a `Utxo` with the `satisfaction_weight` estimate for a legacy P2PKH output.
250         pub fn new_p2pkh(outpoint: OutPoint, value: u64, pubkey_hash: &PubkeyHash) -> Self {
251                 let script_sig_size = 1 /* script_sig length */ +
252                         1 /* OP_PUSH73 */ +
253                         73 /* sig including sighash flag */ +
254                         1 /* OP_PUSH33 */ +
255                         33 /* pubkey */;
256                 Self {
257                         outpoint,
258                         output: TxOut {
259                                 value,
260                                 script_pubkey: ScriptBuf::new_p2pkh(pubkey_hash),
261                         },
262                         satisfaction_weight: script_sig_size * WITNESS_SCALE_FACTOR as u64 + 1 /* empty witness */,
263                 }
264         }
265
266         /// Returns a `Utxo` with the `satisfaction_weight` estimate for a P2WPKH nested in P2SH output.
267         pub fn new_nested_p2wpkh(outpoint: OutPoint, value: u64, pubkey_hash: &WPubkeyHash) -> Self {
268                 let script_sig_size = 1 /* script_sig length */ +
269                         1 /* OP_0 */ +
270                         1 /* OP_PUSH20 */ +
271                         20 /* pubkey_hash */;
272                 Self {
273                         outpoint,
274                         output: TxOut {
275                                 value,
276                                 script_pubkey: ScriptBuf::new_p2sh(&ScriptBuf::new_v0_p2wpkh(pubkey_hash).script_hash()),
277                         },
278                         satisfaction_weight: script_sig_size * WITNESS_SCALE_FACTOR as u64 + P2WPKH_WITNESS_WEIGHT,
279                 }
280         }
281
282         /// Returns a `Utxo` with the `satisfaction_weight` estimate for a SegWit v0 P2WPKH output.
283         pub fn new_v0_p2wpkh(outpoint: OutPoint, value: u64, pubkey_hash: &WPubkeyHash) -> Self {
284                 Self {
285                         outpoint,
286                         output: TxOut {
287                                 value,
288                                 script_pubkey: ScriptBuf::new_v0_p2wpkh(pubkey_hash),
289                         },
290                         satisfaction_weight: EMPTY_SCRIPT_SIG_WEIGHT + P2WPKH_WITNESS_WEIGHT,
291                 }
292         }
293 }
294
295 /// The result of a successful coin selection attempt for a transaction requiring additional UTXOs
296 /// to cover its fees.
297 #[derive(Clone, Debug)]
298 pub struct CoinSelection {
299         /// The set of UTXOs (with at least 1 confirmation) to spend and use within a transaction
300         /// requiring additional fees.
301         pub confirmed_utxos: Vec<Utxo>,
302         /// An additional output tracking whether any change remained after coin selection. This output
303         /// should always have a value above dust for its given `script_pubkey`. It should not be
304         /// spent until the transaction it belongs to confirms to ensure mempool descendant limits are
305         /// not met. This implies no other party should be able to spend it except us.
306         pub change_output: Option<TxOut>,
307 }
308
309 /// An abstraction over a bitcoin wallet that can perform coin selection over a set of UTXOs and can
310 /// sign for them. The coin selection method aims to mimic Bitcoin Core's `fundrawtransaction` RPC,
311 /// which most wallets should be able to satisfy. Otherwise, consider implementing [`WalletSource`],
312 /// which can provide a default implementation of this trait when used with [`Wallet`].
313 pub trait CoinSelectionSource {
314         /// Performs coin selection of a set of UTXOs, with at least 1 confirmation each, that are
315         /// available to spend. Implementations are free to pick their coin selection algorithm of
316         /// choice, as long as the following requirements are met:
317         ///
318         /// 1. `must_spend` contains a set of [`Input`]s that must be included in the transaction
319         ///    throughout coin selection, but must not be returned as part of the result.
320         /// 2. `must_pay_to` contains a set of [`TxOut`]s that must be included in the transaction
321         ///    throughout coin selection. In some cases, like when funding an anchor transaction, this
322         ///    set is empty. Implementations should ensure they handle this correctly on their end,
323         ///    e.g., Bitcoin Core's `fundrawtransaction` RPC requires at least one output to be
324         ///    provided, in which case a zero-value empty OP_RETURN output can be used instead.
325         /// 3. Enough inputs must be selected/contributed for the resulting transaction (including the
326         ///    inputs and outputs noted above) to meet `target_feerate_sat_per_1000_weight`.
327         ///
328         /// Implementations must take note that [`Input::satisfaction_weight`] only tracks the weight of
329         /// the input's `script_sig` and `witness`. Some wallets, like Bitcoin Core's, may require
330         /// providing the full input weight. Failing to do so may lead to underestimating fee bumps and
331         /// delaying block inclusion.
332         ///
333         /// The `claim_id` must map to the set of external UTXOs assigned to the claim, such that they
334         /// can be re-used within new fee-bumped iterations of the original claiming transaction,
335         /// ensuring that claims don't double spend each other. If a specific `claim_id` has never had a
336         /// transaction associated with it, and all of the available UTXOs have already been assigned to
337         /// other claims, implementations must be willing to double spend their UTXOs. The choice of
338         /// which UTXOs to double spend is left to the implementation, but it must strive to keep the
339         /// set of other claims being double spent to a minimum.
340         fn select_confirmed_utxos(
341                 &self, claim_id: ClaimId, must_spend: Vec<Input>, must_pay_to: &[TxOut],
342                 target_feerate_sat_per_1000_weight: u32,
343         ) -> Result<CoinSelection, ()>;
344         /// Signs and provides the full witness for all inputs within the transaction known to the
345         /// trait (i.e., any provided via [`CoinSelectionSource::select_confirmed_utxos`]).
346         fn sign_tx(&self, tx: Transaction) -> Result<Transaction, ()>;
347 }
348
349 /// An alternative to [`CoinSelectionSource`] that can be implemented and used along [`Wallet`] to
350 /// provide a default implementation to [`CoinSelectionSource`].
351 pub trait WalletSource {
352         /// Returns all UTXOs, with at least 1 confirmation each, that are available to spend.
353         fn list_confirmed_utxos(&self) -> Result<Vec<Utxo>, ()>;
354         /// Returns a script to use for change above dust resulting from a successful coin selection
355         /// attempt.
356         fn get_change_script(&self) -> Result<ScriptBuf, ()>;
357         /// Signs and provides the full [`TxIn::script_sig`] and [`TxIn::witness`] for all inputs within
358         /// the transaction known to the wallet (i.e., any provided via
359         /// [`WalletSource::list_confirmed_utxos`]).
360         fn sign_tx(&self, tx: Transaction) -> Result<Transaction, ()>;
361 }
362
363 /// A wrapper over [`WalletSource`] that implements [`CoinSelection`] by preferring UTXOs that would
364 /// avoid conflicting double spends. If not enough UTXOs are available to do so, conflicting double
365 /// spends may happen.
366 pub struct Wallet<W: Deref, L: Deref>
367 where
368         W::Target: WalletSource,
369         L::Target: Logger
370 {
371         source: W,
372         logger: L,
373         // TODO: Do we care about cleaning this up once the UTXOs have a confirmed spend? We can do so
374         // by checking whether any UTXOs that exist in the map are no longer returned in
375         // `list_confirmed_utxos`.
376         locked_utxos: Mutex<HashMap<OutPoint, ClaimId>>,
377 }
378
379 impl<W: Deref, L: Deref> Wallet<W, L>
380 where
381         W::Target: WalletSource,
382         L::Target: Logger
383 {
384         /// Returns a new instance backed by the given [`WalletSource`] that serves as an implementation
385         /// of [`CoinSelectionSource`].
386         pub fn new(source: W, logger: L) -> Self {
387                 Self { source, logger, locked_utxos: Mutex::new(HashMap::new()) }
388         }
389
390         /// Performs coin selection on the set of UTXOs obtained from
391         /// [`WalletSource::list_confirmed_utxos`]. Its algorithm can be described as "smallest
392         /// above-dust-after-spend first", with a slight twist: we may skip UTXOs that are above dust at
393         /// the target feerate after having spent them in a separate claim transaction if
394         /// `force_conflicting_utxo_spend` is unset to avoid producing conflicting transactions. If
395         /// `tolerate_high_network_feerates` is set, we'll attempt to spend UTXOs that contribute at
396         /// least 1 satoshi at the current feerate, otherwise, we'll only attempt to spend those which
397         /// contribute at least twice their fee.
398         fn select_confirmed_utxos_internal(
399                 &self, utxos: &[Utxo], claim_id: ClaimId, force_conflicting_utxo_spend: bool,
400                 tolerate_high_network_feerates: bool, target_feerate_sat_per_1000_weight: u32,
401                 preexisting_tx_weight: u64, input_amount_sat: u64, target_amount_sat: u64,
402         ) -> Result<CoinSelection, ()> {
403                 let mut locked_utxos = self.locked_utxos.lock().unwrap();
404                 let mut eligible_utxos = utxos.iter().filter_map(|utxo| {
405                         if let Some(utxo_claim_id) = locked_utxos.get(&utxo.outpoint) {
406                                 if *utxo_claim_id != claim_id && !force_conflicting_utxo_spend {
407                                         log_trace!(self.logger, "Skipping UTXO {} to prevent conflicting spend", utxo.outpoint);
408                                         return None;
409                                 }
410                         }
411                         let fee_to_spend_utxo = fee_for_weight(
412                                 target_feerate_sat_per_1000_weight, BASE_INPUT_WEIGHT + utxo.satisfaction_weight,
413                         );
414                         let should_spend = if tolerate_high_network_feerates {
415                                 utxo.output.value > fee_to_spend_utxo
416                         } else {
417                                 utxo.output.value >= fee_to_spend_utxo * 2
418                         };
419                         if should_spend {
420                                 Some((utxo, fee_to_spend_utxo))
421                         } else {
422                                 log_trace!(self.logger, "Skipping UTXO {} due to dust proximity after spend", utxo.outpoint);
423                                 None
424                         }
425                 }).collect::<Vec<_>>();
426                 eligible_utxos.sort_unstable_by_key(|(utxo, _)| utxo.output.value);
427
428                 let mut selected_amount = input_amount_sat;
429                 let mut total_fees = fee_for_weight(target_feerate_sat_per_1000_weight, preexisting_tx_weight);
430                 let mut selected_utxos = Vec::new();
431                 for (utxo, fee_to_spend_utxo) in eligible_utxos {
432                         if selected_amount >= target_amount_sat + total_fees {
433                                 break;
434                         }
435                         selected_amount += utxo.output.value;
436                         total_fees += fee_to_spend_utxo;
437                         selected_utxos.push(utxo.clone());
438                 }
439                 if selected_amount < target_amount_sat + total_fees {
440                         log_debug!(self.logger, "Insufficient funds to meet target feerate {} sat/kW",
441                                 target_feerate_sat_per_1000_weight);
442                         return Err(());
443                 }
444                 for utxo in &selected_utxos {
445                         locked_utxos.insert(utxo.outpoint, claim_id);
446                 }
447                 core::mem::drop(locked_utxos);
448
449                 let remaining_amount = selected_amount - target_amount_sat - total_fees;
450                 let change_script = self.source.get_change_script()?;
451                 let change_output_fee = fee_for_weight(
452                         target_feerate_sat_per_1000_weight,
453                         (8 /* value */ + change_script.consensus_encode(&mut sink()).unwrap() as u64) *
454                                 WITNESS_SCALE_FACTOR as u64,
455                 );
456                 let change_output_amount = remaining_amount.saturating_sub(change_output_fee);
457                 let change_output = if change_output_amount < change_script.dust_value().to_sat() {
458                         log_debug!(self.logger, "Coin selection attempt did not yield change output");
459                         None
460                 } else {
461                         Some(TxOut { script_pubkey: change_script, value: change_output_amount })
462                 };
463
464                 Ok(CoinSelection {
465                         confirmed_utxos: selected_utxos,
466                         change_output,
467                 })
468         }
469 }
470
471 impl<W: Deref, L: Deref> CoinSelectionSource for Wallet<W, L>
472 where
473         W::Target: WalletSource,
474         L::Target: Logger
475 {
476         fn select_confirmed_utxos(
477                 &self, claim_id: ClaimId, must_spend: Vec<Input>, must_pay_to: &[TxOut],
478                 target_feerate_sat_per_1000_weight: u32,
479         ) -> Result<CoinSelection, ()> {
480                 let utxos = self.source.list_confirmed_utxos()?;
481                 // TODO: Use fee estimation utils when we upgrade to bitcoin v0.30.0.
482                 const BASE_TX_SIZE: u64 = 4 /* version */ + 1 /* input count */ + 1 /* output count */ + 4 /* locktime */;
483                 let total_output_size: u64 = must_pay_to.iter().map(|output|
484                         8 /* value */ + 1 /* script len */ + output.script_pubkey.len() as u64
485                 ).sum();
486                 let total_satisfaction_weight: u64 = must_spend.iter().map(|input| input.satisfaction_weight).sum();
487                 let total_input_weight = (BASE_INPUT_WEIGHT * must_spend.len() as u64) + total_satisfaction_weight;
488
489                 let preexisting_tx_weight = 2 /* segwit marker & flag */ + total_input_weight +
490                         ((BASE_TX_SIZE + total_output_size) * WITNESS_SCALE_FACTOR as u64);
491                 let input_amount_sat: u64 = must_spend.iter().map(|input| input.previous_utxo.value).sum();
492                 let target_amount_sat = must_pay_to.iter().map(|output| output.value).sum();
493                 let do_coin_selection = |force_conflicting_utxo_spend: bool, tolerate_high_network_feerates: bool| {
494                         log_debug!(self.logger, "Attempting coin selection targeting {} sat/kW (force_conflicting_utxo_spend = {}, tolerate_high_network_feerates = {})",
495                                 target_feerate_sat_per_1000_weight, force_conflicting_utxo_spend, tolerate_high_network_feerates);
496                         self.select_confirmed_utxos_internal(
497                                 &utxos, claim_id, force_conflicting_utxo_spend, tolerate_high_network_feerates,
498                                 target_feerate_sat_per_1000_weight, preexisting_tx_weight, input_amount_sat, target_amount_sat,
499                         )
500                 };
501                 do_coin_selection(false, false)
502                         .or_else(|_| do_coin_selection(false, true))
503                         .or_else(|_| do_coin_selection(true, false))
504                         .or_else(|_| do_coin_selection(true, true))
505         }
506
507         fn sign_tx(&self, tx: Transaction) -> Result<Transaction, ()> {
508                 self.source.sign_tx(tx)
509         }
510 }
511
512 /// A handler for [`Event::BumpTransaction`] events that sources confirmed UTXOs from a
513 /// [`CoinSelectionSource`] to fee bump transactions via Child-Pays-For-Parent (CPFP) or
514 /// Replace-By-Fee (RBF).
515 ///
516 /// [`Event::BumpTransaction`]: crate::events::Event::BumpTransaction
517 pub struct BumpTransactionEventHandler<B: Deref, C: Deref, SP: Deref, L: Deref>
518 where
519         B::Target: BroadcasterInterface,
520         C::Target: CoinSelectionSource,
521         SP::Target: SignerProvider,
522         L::Target: Logger,
523 {
524         broadcaster: B,
525         utxo_source: C,
526         signer_provider: SP,
527         logger: L,
528         secp: Secp256k1<secp256k1::All>,
529 }
530
531 impl<B: Deref, C: Deref, SP: Deref, L: Deref> BumpTransactionEventHandler<B, C, SP, L>
532 where
533         B::Target: BroadcasterInterface,
534         C::Target: CoinSelectionSource,
535         SP::Target: SignerProvider,
536         L::Target: Logger,
537 {
538         /// Returns a new instance capable of handling [`Event::BumpTransaction`] events.
539         ///
540         /// [`Event::BumpTransaction`]: crate::events::Event::BumpTransaction
541         pub fn new(broadcaster: B, utxo_source: C, signer_provider: SP, logger: L) -> Self {
542                 Self {
543                         broadcaster,
544                         utxo_source,
545                         signer_provider,
546                         logger,
547                         secp: Secp256k1::new(),
548                 }
549         }
550
551         /// Updates a transaction with the result of a successful coin selection attempt.
552         fn process_coin_selection(&self, tx: &mut Transaction, mut coin_selection: CoinSelection) {
553                 for utxo in coin_selection.confirmed_utxos.drain(..) {
554                         tx.input.push(TxIn {
555                                 previous_output: utxo.outpoint,
556                                 script_sig: ScriptBuf::new(),
557                                 sequence: Sequence::ZERO,
558                                 witness: Witness::new(),
559                         });
560                 }
561                 if let Some(change_output) = coin_selection.change_output.take() {
562                         tx.output.push(change_output);
563                 } else if tx.output.is_empty() {
564                         // We weren't provided a change output, likely because the input set was a perfect
565                         // match, but we still need to have at least one output in the transaction for it to be
566                         // considered standard. We choose to go with an empty OP_RETURN as it is the cheapest
567                         // way to include a dummy output.
568                         log_debug!(self.logger, "Including dummy OP_RETURN output since an output is needed and a change output was not provided");
569                         tx.output.push(TxOut {
570                                 value: 0,
571                                 script_pubkey: ScriptBuf::new_op_return(&[]),
572                         });
573                 }
574         }
575
576         /// Handles a [`BumpTransactionEvent::ChannelClose`] event variant by producing a fully-signed
577         /// transaction spending an anchor output of the commitment transaction to bump its fee and
578         /// broadcasts them to the network as a package.
579         fn handle_channel_close(
580                 &self, claim_id: ClaimId, package_target_feerate_sat_per_1000_weight: u32,
581                 commitment_tx: &Transaction, commitment_tx_fee_sat: u64, anchor_descriptor: &AnchorDescriptor,
582         ) -> Result<(), ()> {
583                 // Our commitment transaction already has fees allocated to it, so we should take them into
584                 // account. We do so by pretending the commitment tranasction's fee and weight are part of
585                 // the anchor input.
586                 let mut anchor_utxo = anchor_descriptor.previous_utxo();
587                 anchor_utxo.value += commitment_tx_fee_sat;
588                 let must_spend = vec![Input {
589                         outpoint: anchor_descriptor.outpoint,
590                         previous_utxo: anchor_utxo,
591                         satisfaction_weight: commitment_tx.weight().to_wu() + ANCHOR_INPUT_WITNESS_WEIGHT + EMPTY_SCRIPT_SIG_WEIGHT,
592                 }];
593                 #[cfg(debug_assertions)]
594                 let must_spend_amount = must_spend.iter().map(|input| input.previous_utxo.value).sum::<u64>();
595
596                 log_debug!(self.logger, "Peforming coin selection for commitment package (commitment and anchor transaction) targeting {} sat/kW",
597                         package_target_feerate_sat_per_1000_weight);
598                 let coin_selection = self.utxo_source.select_confirmed_utxos(
599                         claim_id, must_spend, &[], package_target_feerate_sat_per_1000_weight,
600                 )?;
601
602                 let mut anchor_tx = Transaction {
603                         version: 2,
604                         lock_time: LockTime::ZERO, // TODO: Use next best height.
605                         input: vec![anchor_descriptor.unsigned_tx_input()],
606                         output: vec![],
607                 };
608
609                 #[cfg(debug_assertions)]
610                 let total_satisfaction_weight = ANCHOR_INPUT_WITNESS_WEIGHT + EMPTY_SCRIPT_SIG_WEIGHT +
611                         coin_selection.confirmed_utxos.iter().map(|utxo| utxo.satisfaction_weight).sum::<u64>();
612                 #[cfg(debug_assertions)]
613                 let total_input_amount = must_spend_amount +
614                         coin_selection.confirmed_utxos.iter().map(|utxo| utxo.output.value).sum::<u64>();
615
616                 self.process_coin_selection(&mut anchor_tx, coin_selection);
617                 let anchor_txid = anchor_tx.txid();
618
619                 debug_assert_eq!(anchor_tx.output.len(), 1);
620                 #[cfg(debug_assertions)]
621                 let unsigned_tx_weight = anchor_tx.weight().to_wu() - (anchor_tx.input.len() as u64 * EMPTY_SCRIPT_SIG_WEIGHT);
622
623                 log_debug!(self.logger, "Signing anchor transaction {}", anchor_txid);
624                 anchor_tx = self.utxo_source.sign_tx(anchor_tx)?;
625
626                 let signer = anchor_descriptor.derive_channel_signer(&self.signer_provider);
627                 let anchor_sig = signer.sign_holder_anchor_input(&anchor_tx, 0, &self.secp)?;
628                 anchor_tx.input[0].witness = anchor_descriptor.tx_input_witness(&anchor_sig);
629
630                 #[cfg(debug_assertions)] {
631                         let signed_tx_weight = anchor_tx.weight().to_wu();
632                         let expected_signed_tx_weight = unsigned_tx_weight + total_satisfaction_weight;
633                         // Our estimate should be within a 1% error margin of the actual weight and we should
634                         // never underestimate.
635                         assert!(expected_signed_tx_weight >= signed_tx_weight &&
636                                 expected_signed_tx_weight - (expected_signed_tx_weight / 100) <= signed_tx_weight);
637
638                         let expected_package_fee = fee_for_weight(package_target_feerate_sat_per_1000_weight,
639                                 signed_tx_weight + commitment_tx.weight().to_wu());
640                         let package_fee = total_input_amount -
641                                 anchor_tx.output.iter().map(|output| output.value).sum::<u64>();
642                         // Our fee should be within a 5% error margin of the expected fee based on the
643                         // feerate and transaction weight and we should never pay less than required.
644                         let fee_error_margin = expected_package_fee * 5 / 100;
645                         assert!(package_fee >= expected_package_fee &&
646                                 package_fee - fee_error_margin <= expected_package_fee);
647                 }
648
649                 log_info!(self.logger, "Broadcasting anchor transaction {} to bump channel close with txid {}",
650                         anchor_txid, commitment_tx.txid());
651                 self.broadcaster.broadcast_transactions(&[&commitment_tx, &anchor_tx]);
652                 Ok(())
653         }
654
655         /// Handles a [`BumpTransactionEvent::HTLCResolution`] event variant by producing a
656         /// fully-signed, fee-bumped HTLC transaction that is broadcast to the network.
657         fn handle_htlc_resolution(
658                 &self, claim_id: ClaimId, target_feerate_sat_per_1000_weight: u32,
659                 htlc_descriptors: &[HTLCDescriptor], tx_lock_time: LockTime,
660         ) -> Result<(), ()> {
661                 let mut htlc_tx = Transaction {
662                         version: 2,
663                         lock_time: tx_lock_time,
664                         input: vec![],
665                         output: vec![],
666                 };
667                 let mut must_spend = Vec::with_capacity(htlc_descriptors.len());
668                 for htlc_descriptor in htlc_descriptors {
669                         let htlc_input = htlc_descriptor.unsigned_tx_input();
670                         must_spend.push(Input {
671                                 outpoint: htlc_input.previous_output.clone(),
672                                 previous_utxo: htlc_descriptor.previous_utxo(&self.secp),
673                                 satisfaction_weight: EMPTY_SCRIPT_SIG_WEIGHT + if htlc_descriptor.preimage.is_some() {
674                                         HTLC_SUCCESS_INPUT_ANCHOR_WITNESS_WEIGHT
675                                 } else {
676                                         HTLC_TIMEOUT_INPUT_ANCHOR_WITNESS_WEIGHT
677                                 },
678                         });
679                         htlc_tx.input.push(htlc_input);
680                         let htlc_output = htlc_descriptor.tx_output(&self.secp);
681                         htlc_tx.output.push(htlc_output);
682                 }
683
684                 log_debug!(self.logger, "Peforming coin selection for HTLC transaction targeting {} sat/kW",
685                         target_feerate_sat_per_1000_weight);
686
687                 #[cfg(debug_assertions)]
688                 let must_spend_satisfaction_weight =
689                         must_spend.iter().map(|input| input.satisfaction_weight).sum::<u64>();
690                 #[cfg(debug_assertions)]
691                 let must_spend_amount = must_spend.iter().map(|input| input.previous_utxo.value).sum::<u64>();
692
693                 let coin_selection = self.utxo_source.select_confirmed_utxos(
694                         claim_id, must_spend, &htlc_tx.output, target_feerate_sat_per_1000_weight,
695                 )?;
696
697                 #[cfg(debug_assertions)]
698                 let total_satisfaction_weight = must_spend_satisfaction_weight +
699                         coin_selection.confirmed_utxos.iter().map(|utxo| utxo.satisfaction_weight).sum::<u64>();
700                 #[cfg(debug_assertions)]
701                 let total_input_amount = must_spend_amount +
702                         coin_selection.confirmed_utxos.iter().map(|utxo| utxo.output.value).sum::<u64>();
703
704                 self.process_coin_selection(&mut htlc_tx, coin_selection);
705
706                 #[cfg(debug_assertions)]
707                 let unsigned_tx_weight = htlc_tx.weight().to_wu() - (htlc_tx.input.len() as u64 * EMPTY_SCRIPT_SIG_WEIGHT);
708
709                 log_debug!(self.logger, "Signing HTLC transaction {}", htlc_tx.txid());
710                 htlc_tx = self.utxo_source.sign_tx(htlc_tx)?;
711
712                 let mut signers = BTreeMap::new();
713                 for (idx, htlc_descriptor) in htlc_descriptors.iter().enumerate() {
714                         let signer = signers.entry(htlc_descriptor.channel_derivation_parameters.keys_id)
715                                 .or_insert_with(|| htlc_descriptor.derive_channel_signer(&self.signer_provider));
716                         let htlc_sig = signer.sign_holder_htlc_transaction(&htlc_tx, idx, htlc_descriptor, &self.secp)?;
717                         let witness_script = htlc_descriptor.witness_script(&self.secp);
718                         htlc_tx.input[idx].witness = htlc_descriptor.tx_input_witness(&htlc_sig, &witness_script);
719                 }
720
721                 #[cfg(debug_assertions)] {
722                         let signed_tx_weight = htlc_tx.weight().to_wu();
723                         let expected_signed_tx_weight = unsigned_tx_weight + total_satisfaction_weight;
724                         // Our estimate should be within a 1% error margin of the actual weight and we should
725                         // never underestimate.
726                         assert!(expected_signed_tx_weight >= signed_tx_weight &&
727                                 expected_signed_tx_weight - (expected_signed_tx_weight / 100) <= signed_tx_weight);
728
729                         let expected_signed_tx_fee = fee_for_weight(target_feerate_sat_per_1000_weight, signed_tx_weight);
730                         let signed_tx_fee = total_input_amount -
731                                 htlc_tx.output.iter().map(|output| output.value).sum::<u64>();
732                         // Our fee should be within a 5% error margin of the expected fee based on the
733                         // feerate and transaction weight and we should never pay less than required.
734                         let fee_error_margin = expected_signed_tx_fee * 5 / 100;
735                         assert!(signed_tx_fee >= expected_signed_tx_fee &&
736                                 signed_tx_fee - fee_error_margin <= expected_signed_tx_fee);
737                 }
738
739                 log_info!(self.logger, "Broadcasting {}", log_tx!(htlc_tx));
740                 self.broadcaster.broadcast_transactions(&[&htlc_tx]);
741                 Ok(())
742         }
743
744         /// Handles all variants of [`BumpTransactionEvent`].
745         pub fn handle_event(&self, event: &BumpTransactionEvent) {
746                 match event {
747                         BumpTransactionEvent::ChannelClose {
748                                 claim_id, package_target_feerate_sat_per_1000_weight, commitment_tx,
749                                 commitment_tx_fee_satoshis, anchor_descriptor, ..
750                         } => {
751                                 log_info!(self.logger, "Handling channel close bump (claim_id = {}, commitment_txid = {})",
752                                         log_bytes!(claim_id.0), commitment_tx.txid());
753                                 if let Err(_) = self.handle_channel_close(
754                                         *claim_id, *package_target_feerate_sat_per_1000_weight, commitment_tx,
755                                         *commitment_tx_fee_satoshis, anchor_descriptor,
756                                 ) {
757                                         log_error!(self.logger, "Failed bumping commitment transaction fee for {}",
758                                                 commitment_tx.txid());
759                                 }
760                         }
761                         BumpTransactionEvent::HTLCResolution {
762                                 claim_id, target_feerate_sat_per_1000_weight, htlc_descriptors, tx_lock_time,
763                         } => {
764                                 log_info!(self.logger, "Handling HTLC bump (claim_id = {}, htlcs_to_claim = {})",
765                                         log_bytes!(claim_id.0), log_iter!(htlc_descriptors.iter().map(|d| d.outpoint())));
766                                 if let Err(_) = self.handle_htlc_resolution(
767                                         *claim_id, *target_feerate_sat_per_1000_weight, htlc_descriptors, *tx_lock_time,
768                                 ) {
769                                         log_error!(self.logger, "Failed bumping HTLC transaction fee for commitment {}",
770                                                 htlc_descriptors[0].commitment_txid);
771                                 }
772                         }
773                 }
774         }
775 }