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