X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fevents%2Fbump_transaction.rs;h=8b52af69fe331527a43ae38e0a67cd94e4ea4139;hb=c39c398f0618835201fb741b1976952c3f9180fa;hp=1fd533d2fd27f1e9637096d8de287139456b3b9d;hpb=8f308f98dda28f54e1c7603be5a440a8c0c101c8;p=rust-lightning diff --git a/lightning/src/events/bump_transaction.rs b/lightning/src/events/bump_transaction.rs index 1fd533d2..8b52af69 100644 --- a/lightning/src/events/bump_transaction.rs +++ b/lightning/src/events/bump_transaction.rs @@ -18,6 +18,7 @@ use crate::chain::chaininterface::{BroadcasterInterface, fee_for_weight}; use crate::chain::ClaimId; use crate::io_extras::sink; use crate::ln::channel::ANCHOR_OUTPUT_VALUE_SATOSHI; +use crate::ln::ChannelId; use crate::ln::chan_utils; use crate::ln::chan_utils::{ ANCHOR_INPUT_WITNESS_WEIGHT, HTLC_SUCCESS_INPUT_ANCHOR_WITNESS_WEIGHT, @@ -25,24 +26,26 @@ use crate::ln::chan_utils::{ }; use crate::prelude::*; use crate::sign::{ - ChannelDerivationParameters, HTLCDescriptor, EcdsaChannelSigner, SignerProvider, - WriteableEcdsaChannelSigner, P2WPKH_WITNESS_WEIGHT + ChannelDerivationParameters, HTLCDescriptor, SignerProvider, P2WPKH_WITNESS_WEIGHT }; +use crate::sign::ecdsa::{EcdsaChannelSigner, WriteableEcdsaChannelSigner}; use crate::sync::Mutex; use crate::util::logger::Logger; -use bitcoin::{OutPoint, PackedLockTime, PubkeyHash, Sequence, Script, Transaction, TxIn, TxOut, Witness, WPubkeyHash}; +use bitcoin::{OutPoint, PubkeyHash, Sequence, ScriptBuf, Transaction, TxIn, TxOut, Witness, WPubkeyHash}; use bitcoin::blockdata::constants::WITNESS_SCALE_FACTOR; +use bitcoin::blockdata::locktime::absolute::LockTime; use bitcoin::consensus::Encodable; +use bitcoin::psbt::PartiallySignedTransaction; use bitcoin::secp256k1; -use bitcoin::secp256k1::Secp256k1; +use bitcoin::secp256k1::{PublicKey, Secp256k1}; use bitcoin::secp256k1::ecdsa::Signature; -const EMPTY_SCRIPT_SIG_WEIGHT: u64 = 1 /* empty script_sig */ * WITNESS_SCALE_FACTOR as u64; +pub(crate) const EMPTY_SCRIPT_SIG_WEIGHT: u64 = 1 /* empty script_sig */ * WITNESS_SCALE_FACTOR as u64; const BASE_INPUT_SIZE: u64 = 32 /* txid */ + 4 /* vout */ + 4 /* sequence */; -const BASE_INPUT_WEIGHT: u64 = BASE_INPUT_SIZE * WITNESS_SCALE_FACTOR as u64; +pub(crate) const BASE_INPUT_WEIGHT: u64 = BASE_INPUT_SIZE * WITNESS_SCALE_FACTOR as u64; /// A descriptor used to sign for a commitment transaction's anchor output. #[derive(Clone, Debug, PartialEq, Eq)] @@ -69,14 +72,14 @@ impl AnchorDescriptor { pub fn unsigned_tx_input(&self) -> TxIn { TxIn { previous_output: self.outpoint.clone(), - script_sig: Script::new(), + script_sig: ScriptBuf::new(), sequence: Sequence::ENABLE_RBF_NO_LOCKTIME, witness: Witness::new(), } } /// Returns the witness script of the anchor output in the commitment transaction. - pub fn witness_script(&self) -> Script { + pub fn witness_script(&self) -> ScriptBuf { let channel_params = self.channel_derivation_parameters.transaction_parameters.as_holder_broadcastable(); chan_utils::get_anchor_redeemscript(&channel_params.broadcaster_pubkeys().funding_pubkey) } @@ -91,7 +94,7 @@ impl AnchorDescriptor { /// Derives the channel signer required to sign the anchor input. pub fn derive_channel_signer(&self, signer_provider: &SP) -> S where - SP::Target: SignerProvider + SP::Target: SignerProvider { let mut signer = signer_provider.derive_channel_signer( self.channel_derivation_parameters.value_satoshis, @@ -141,10 +144,14 @@ pub enum BumpTransactionEvent { /// an empty `pending_htlcs`), confirmation of the commitment transaction can be considered to /// be not urgent. /// - /// [`EcdsaChannelSigner`]: crate::sign::EcdsaChannelSigner - /// [`EcdsaChannelSigner::sign_holder_anchor_input`]: crate::sign::EcdsaChannelSigner::sign_holder_anchor_input + /// [`EcdsaChannelSigner`]: crate::sign::ecdsa::EcdsaChannelSigner + /// [`EcdsaChannelSigner::sign_holder_anchor_input`]: crate::sign::ecdsa::EcdsaChannelSigner::sign_holder_anchor_input /// [`build_anchor_input_witness`]: crate::ln::chan_utils::build_anchor_input_witness ChannelClose { + /// The `channel_id` of the channel which has been closed. + channel_id: ChannelId, + /// Counterparty in the closed channel. + counterparty_node_id: PublicKey, /// The unique identifier for the claim of the anchor output in the commitment transaction. /// /// The identifier must map to the set of external UTXOs assigned to the claim, such that @@ -195,9 +202,13 @@ pub enum BumpTransactionEvent { /// longer able to commit external confirmed funds to the HTLC transaction or the fee committed /// to the HTLC transaction is greater in value than the HTLCs being claimed. /// - /// [`EcdsaChannelSigner`]: crate::sign::EcdsaChannelSigner - /// [`EcdsaChannelSigner::sign_holder_htlc_transaction`]: crate::sign::EcdsaChannelSigner::sign_holder_htlc_transaction + /// [`EcdsaChannelSigner`]: crate::sign::ecdsa::EcdsaChannelSigner + /// [`EcdsaChannelSigner::sign_holder_htlc_transaction`]: crate::sign::ecdsa::EcdsaChannelSigner::sign_holder_htlc_transaction HTLCResolution { + /// The `channel_id` of the channel which has been closed. + channel_id: ChannelId, + /// Counterparty in the closed channel. + counterparty_node_id: PublicKey, /// The unique identifier for the claim of the HTLCs in the confirmed commitment /// transaction. /// @@ -211,7 +222,7 @@ pub enum BumpTransactionEvent { /// by the same transaction. htlc_descriptors: Vec, /// The locktime required for the resulting HTLC transaction. - tx_lock_time: PackedLockTime, + tx_lock_time: LockTime, }, } @@ -256,7 +267,7 @@ impl Utxo { outpoint, output: TxOut { value, - script_pubkey: Script::new_p2pkh(pubkey_hash), + script_pubkey: ScriptBuf::new_p2pkh(pubkey_hash), }, satisfaction_weight: script_sig_size * WITNESS_SCALE_FACTOR as u64 + 1 /* empty witness */, } @@ -272,7 +283,7 @@ impl Utxo { outpoint, output: TxOut { value, - script_pubkey: Script::new_p2sh(&Script::new_v0_p2wpkh(pubkey_hash).script_hash()), + script_pubkey: ScriptBuf::new_p2sh(&ScriptBuf::new_v0_p2wpkh(pubkey_hash).script_hash()), }, satisfaction_weight: script_sig_size * WITNESS_SCALE_FACTOR as u64 + P2WPKH_WITNESS_WEIGHT, } @@ -284,7 +295,7 @@ impl Utxo { outpoint, output: TxOut { value, - script_pubkey: Script::new_v0_p2wpkh(pubkey_hash), + script_pubkey: ScriptBuf::new_v0_p2wpkh(pubkey_hash), }, satisfaction_weight: EMPTY_SCRIPT_SIG_WEIGHT + P2WPKH_WITNESS_WEIGHT, } @@ -342,7 +353,10 @@ pub trait CoinSelectionSource { ) -> Result; /// Signs and provides the full witness for all inputs within the transaction known to the /// trait (i.e., any provided via [`CoinSelectionSource::select_confirmed_utxos`]). - fn sign_tx(&self, tx: Transaction) -> Result; + /// + /// If your wallet does not support signing PSBTs you can call `psbt.extract_tx()` to get the + /// unsigned transaction and then sign it with your wallet. + fn sign_psbt(&self, psbt: PartiallySignedTransaction) -> Result; } /// An alternative to [`CoinSelectionSource`] that can be implemented and used along [`Wallet`] to @@ -352,11 +366,14 @@ pub trait WalletSource { fn list_confirmed_utxos(&self) -> Result, ()>; /// Returns a script to use for change above dust resulting from a successful coin selection /// attempt. - fn get_change_script(&self) -> Result; + fn get_change_script(&self) -> Result; /// Signs and provides the full [`TxIn::script_sig`] and [`TxIn::witness`] for all inputs within /// the transaction known to the wallet (i.e., any provided via /// [`WalletSource::list_confirmed_utxos`]). - fn sign_tx(&self, tx: Transaction) -> Result; + /// + /// If your wallet does not support signing PSBTs you can call `psbt.extract_tx()` to get the + /// unsigned transaction and then sign it with your wallet. + fn sign_psbt(&self, psbt: PartiallySignedTransaction) -> Result; } /// A wrapper over [`WalletSource`] that implements [`CoinSelection`] by preferring UTXOs that would @@ -383,7 +400,7 @@ where /// Returns a new instance backed by the given [`WalletSource`] that serves as an implementation /// of [`CoinSelectionSource`]. pub fn new(source: W, logger: L) -> Self { - Self { source, logger, locked_utxos: Mutex::new(HashMap::new()) } + Self { source, logger, locked_utxos: Mutex::new(new_hash_map()) } } /// Performs coin selection on the set of UTXOs obtained from @@ -408,7 +425,7 @@ where } } let fee_to_spend_utxo = fee_for_weight( - target_feerate_sat_per_1000_weight, BASE_INPUT_WEIGHT as u64 + utxo.satisfaction_weight, + target_feerate_sat_per_1000_weight, BASE_INPUT_WEIGHT + utxo.satisfaction_weight, ); let should_spend = if tolerate_high_network_feerates { utxo.output.value > fee_to_spend_utxo @@ -503,8 +520,8 @@ where .or_else(|_| do_coin_selection(true, true)) } - fn sign_tx(&self, tx: Transaction) -> Result { - self.source.sign_tx(tx) + fn sign_psbt(&self, psbt: PartiallySignedTransaction) -> Result { + self.source.sign_psbt(psbt) } } @@ -548,16 +565,16 @@ where } /// Updates a transaction with the result of a successful coin selection attempt. - fn process_coin_selection(&self, tx: &mut Transaction, mut coin_selection: CoinSelection) { - for utxo in coin_selection.confirmed_utxos.drain(..) { + fn process_coin_selection(&self, tx: &mut Transaction, coin_selection: &CoinSelection) { + for utxo in coin_selection.confirmed_utxos.iter() { tx.input.push(TxIn { previous_output: utxo.outpoint, - script_sig: Script::new(), + script_sig: ScriptBuf::new(), sequence: Sequence::ZERO, witness: Witness::new(), }); } - if let Some(change_output) = coin_selection.change_output.take() { + if let Some(change_output) = coin_selection.change_output.clone() { tx.output.push(change_output); } else if tx.output.is_empty() { // We weren't provided a change output, likely because the input set was a perfect @@ -567,7 +584,7 @@ where log_debug!(self.logger, "Including dummy OP_RETURN output since an output is needed and a change output was not provided"); tx.output.push(TxOut { value: 0, - script_pubkey: Script::new_op_return(&[]), + script_pubkey: ScriptBuf::new_op_return(&[]), }); } } @@ -587,20 +604,20 @@ where let must_spend = vec![Input { outpoint: anchor_descriptor.outpoint, previous_utxo: anchor_utxo, - satisfaction_weight: commitment_tx.weight() as u64 + ANCHOR_INPUT_WITNESS_WEIGHT + EMPTY_SCRIPT_SIG_WEIGHT, + satisfaction_weight: commitment_tx.weight().to_wu() + ANCHOR_INPUT_WITNESS_WEIGHT + EMPTY_SCRIPT_SIG_WEIGHT, }]; #[cfg(debug_assertions)] let must_spend_amount = must_spend.iter().map(|input| input.previous_utxo.value).sum::(); log_debug!(self.logger, "Peforming coin selection for commitment package (commitment and anchor transaction) targeting {} sat/kW", package_target_feerate_sat_per_1000_weight); - let coin_selection = self.utxo_source.select_confirmed_utxos( + let coin_selection: CoinSelection = self.utxo_source.select_confirmed_utxos( claim_id, must_spend, &[], package_target_feerate_sat_per_1000_weight, )?; let mut anchor_tx = Transaction { version: 2, - lock_time: PackedLockTime::ZERO, // TODO: Use next best height. + lock_time: LockTime::ZERO, // TODO: Use next best height. input: vec![anchor_descriptor.unsigned_tx_input()], output: vec![], }; @@ -612,22 +629,36 @@ where let total_input_amount = must_spend_amount + coin_selection.confirmed_utxos.iter().map(|utxo| utxo.output.value).sum::(); - self.process_coin_selection(&mut anchor_tx, coin_selection); + self.process_coin_selection(&mut anchor_tx, &coin_selection); let anchor_txid = anchor_tx.txid(); - debug_assert_eq!(anchor_tx.output.len(), 1); + // construct psbt + let mut anchor_psbt = PartiallySignedTransaction::from_unsigned_tx(anchor_tx).unwrap(); + // add witness_utxo to anchor input + anchor_psbt.inputs[0].witness_utxo = Some(anchor_descriptor.previous_utxo()); + // add witness_utxo to remaining inputs + for (idx, utxo) in coin_selection.confirmed_utxos.into_iter().enumerate() { + // add 1 to skip the anchor input + let index = idx + 1; + debug_assert_eq!(anchor_psbt.unsigned_tx.input[index].previous_output, utxo.outpoint); + if utxo.output.script_pubkey.is_witness_program() { + anchor_psbt.inputs[index].witness_utxo = Some(utxo.output); + } + } + + debug_assert_eq!(anchor_psbt.unsigned_tx.output.len(), 1); #[cfg(debug_assertions)] - let unsigned_tx_weight = anchor_tx.weight() as u64 - (anchor_tx.input.len() as u64 * EMPTY_SCRIPT_SIG_WEIGHT); + let unsigned_tx_weight = anchor_psbt.unsigned_tx.weight().to_wu() - (anchor_psbt.unsigned_tx.input.len() as u64 * EMPTY_SCRIPT_SIG_WEIGHT); log_debug!(self.logger, "Signing anchor transaction {}", anchor_txid); - anchor_tx = self.utxo_source.sign_tx(anchor_tx)?; + anchor_tx = self.utxo_source.sign_psbt(anchor_psbt)?; let signer = anchor_descriptor.derive_channel_signer(&self.signer_provider); let anchor_sig = signer.sign_holder_anchor_input(&anchor_tx, 0, &self.secp)?; anchor_tx.input[0].witness = anchor_descriptor.tx_input_witness(&anchor_sig); #[cfg(debug_assertions)] { - let signed_tx_weight = anchor_tx.weight() as u64; + let signed_tx_weight = anchor_tx.weight().to_wu(); let expected_signed_tx_weight = unsigned_tx_weight + total_satisfaction_weight; // Our estimate should be within a 1% error margin of the actual weight and we should // never underestimate. @@ -635,7 +666,7 @@ where expected_signed_tx_weight - (expected_signed_tx_weight / 100) <= signed_tx_weight); let expected_package_fee = fee_for_weight(package_target_feerate_sat_per_1000_weight, - signed_tx_weight + commitment_tx.weight() as u64); + signed_tx_weight + commitment_tx.weight().to_wu()); let package_fee = total_input_amount - anchor_tx.output.iter().map(|output| output.value).sum::(); // Our fee should be within a 5% error margin of the expected fee based on the @@ -655,7 +686,7 @@ where /// fully-signed, fee-bumped HTLC transaction that is broadcast to the network. fn handle_htlc_resolution( &self, claim_id: ClaimId, target_feerate_sat_per_1000_weight: u32, - htlc_descriptors: &[HTLCDescriptor], tx_lock_time: PackedLockTime, + htlc_descriptors: &[HTLCDescriptor], tx_lock_time: LockTime, ) -> Result<(), ()> { let mut htlc_tx = Transaction { version: 2, @@ -689,7 +720,7 @@ where #[cfg(debug_assertions)] let must_spend_amount = must_spend.iter().map(|input| input.previous_utxo.value).sum::(); - let coin_selection = self.utxo_source.select_confirmed_utxos( + let coin_selection: CoinSelection = self.utxo_source.select_confirmed_utxos( claim_id, must_spend, &htlc_tx.output, target_feerate_sat_per_1000_weight, )?; @@ -700,13 +731,30 @@ where let total_input_amount = must_spend_amount + coin_selection.confirmed_utxos.iter().map(|utxo| utxo.output.value).sum::(); - self.process_coin_selection(&mut htlc_tx, coin_selection); + self.process_coin_selection(&mut htlc_tx, &coin_selection); + + // construct psbt + let mut htlc_psbt = PartiallySignedTransaction::from_unsigned_tx(htlc_tx).unwrap(); + // add witness_utxo to htlc inputs + for (i, htlc_descriptor) in htlc_descriptors.iter().enumerate() { + debug_assert_eq!(htlc_psbt.unsigned_tx.input[i].previous_output, htlc_descriptor.outpoint()); + htlc_psbt.inputs[i].witness_utxo = Some(htlc_descriptor.previous_utxo(&self.secp)); + } + // add witness_utxo to remaining inputs + for (idx, utxo) in coin_selection.confirmed_utxos.into_iter().enumerate() { + // offset to skip the htlc inputs + let index = idx + htlc_descriptors.len(); + debug_assert_eq!(htlc_psbt.unsigned_tx.input[index].previous_output, utxo.outpoint); + if utxo.output.script_pubkey.is_witness_program() { + htlc_psbt.inputs[index].witness_utxo = Some(utxo.output); + } + } #[cfg(debug_assertions)] - let unsigned_tx_weight = htlc_tx.weight() as u64 - (htlc_tx.input.len() as u64 * EMPTY_SCRIPT_SIG_WEIGHT); + let unsigned_tx_weight = htlc_psbt.unsigned_tx.weight().to_wu() - (htlc_psbt.unsigned_tx.input.len() as u64 * EMPTY_SCRIPT_SIG_WEIGHT); - log_debug!(self.logger, "Signing HTLC transaction {}", htlc_tx.txid()); - htlc_tx = self.utxo_source.sign_tx(htlc_tx)?; + log_debug!(self.logger, "Signing HTLC transaction {}", htlc_psbt.unsigned_tx.txid()); + htlc_tx = self.utxo_source.sign_psbt(htlc_psbt)?; let mut signers = BTreeMap::new(); for (idx, htlc_descriptor) in htlc_descriptors.iter().enumerate() { @@ -718,7 +766,7 @@ where } #[cfg(debug_assertions)] { - let signed_tx_weight = htlc_tx.weight() as u64; + let signed_tx_weight = htlc_tx.weight().to_wu(); let expected_signed_tx_weight = unsigned_tx_weight + total_satisfaction_weight; // Our estimate should be within a 1% error margin of the actual weight and we should // never underestimate. @@ -758,7 +806,7 @@ where } } BumpTransactionEvent::HTLCResolution { - claim_id, target_feerate_sat_per_1000_weight, htlc_descriptors, tx_lock_time, + claim_id, target_feerate_sat_per_1000_weight, htlc_descriptors, tx_lock_time, .. } => { log_info!(self.logger, "Handling HTLC bump (claim_id = {}, htlcs_to_claim = {})", log_bytes!(claim_id.0), log_iter!(htlc_descriptors.iter().map(|d| d.outpoint())));