fix Use SharedOwnedOutput for shared_funding_output

Author: optout21

lightning/src/ln/channel.rs

@@ -57,7 +57,8 @@ use crate::ln::channelmanager::{
 use crate::ln::interactivetxs::{
 	calculate_change_output_value, get_output_weight, AbortReason, HandleTxCompleteResult,
 	InteractiveTxConstructor, InteractiveTxConstructorArgs, InteractiveTxMessageSend,
-	InteractiveTxMessageSendResult, InteractiveTxSigningSession, TX_COMMON_FIELDS_WEIGHT,
+	InteractiveTxMessageSendResult, InteractiveTxSigningSession, SharedOwnedOutput,
+	TX_COMMON_FIELDS_WEIGHT,
 };
 use crate::ln::msgs;
 use crate::ln::msgs::{ClosingSigned, ClosingSignedFeeRange, DecodeError, OnionErrorPacket};
@@ -2670,7 +2671,7 @@ where
 			is_initiator: self.funding.is_outbound(),
 			funding_tx_locktime: self.dual_funding_context.funding_tx_locktime,
 			inputs_to_contribute: funding_inputs,
-			shared_funding_output: (shared_funding_output, self.dual_funding_context.our_funding_satoshis),
+			shared_funding_output: SharedOwnedOutput::new(shared_funding_output, self.dual_funding_context.our_funding_satoshis),
 			outputs_to_contribute: funding_outputs,
 		};
 		let mut tx_constructor = InteractiveTxConstructor::new(constructor_args)?;
@@ -11053,7 +11054,7 @@ where
 				funding_tx_locktime: dual_funding_context.funding_tx_locktime,
 				is_initiator: false,
 				inputs_to_contribute: our_funding_inputs,
-				shared_funding_output: (shared_funding_output, our_funding_satoshis),
+				shared_funding_output: SharedOwnedOutput::new(shared_funding_output, our_funding_satoshis),
 				outputs_to_contribute: Vec::new(),
 			}
 		).map_err(|_| ChannelError::Close((

lightning/src/ln/interactivetxs.rs

@@ -470,13 +470,9 @@ struct NegotiationContext {
 	/// - For the initiator:
 	/// The output intended to be the new funding output. This will be added alonside to the
 	/// provided outputs.
-	/// The value is the holder's intended contribution to the shared funding output
-	/// (must be less or equal then the amount of the output).
 	/// - For the acceptor:
 	/// The output expected as new funding output. It should be added by the initiator node.
-	/// The value is the holder's intended contribution to the shared funding output
-	/// (must be less or equal then the amount of the output).
-	shared_funding_output: (TxOut, u64),
+	shared_funding_output: SharedOwnedOutput,
 	prevtx_outpoints: HashSet<OutPoint>,
 	/// The outputs added so far.
 	outputs: HashMap<SerialId, InteractiveTxOutput>,
@@ -513,7 +509,7 @@ fn is_serial_id_valid_for_counterparty(holder_is_initiator: bool, serial_id: Ser
 impl NegotiationContext {
 	fn new(
 		holder_node_id: PublicKey, counterparty_node_id: PublicKey, holder_is_initiator: bool,
-		shared_funding_output: (TxOut, u64), tx_locktime: AbsoluteLockTime,
+		shared_funding_output: SharedOwnedOutput, tx_locktime: AbsoluteLockTime,
 		feerate_sat_per_kw: u32,
 	) -> Self {
 		NegotiationContext {
@@ -725,7 +721,7 @@ impl NegotiationContext {
 		}
 
 		let txout = TxOut { value: Amount::from_sat(msg.sats), script_pubkey: msg.script.clone() };
-		let output = if txout == self.shared_funding_output.0 {
+		let output = if txout == self.shared_funding_output.tx_out {
 			// this is the shared output
 			if self.holder_is_initiator {
 				return Err(AbortReason::DuplicateFundingOutput);
@@ -734,7 +730,7 @@ impl NegotiationContext {
 			if self.outputs.values().any(|output| matches!(output.output, OutputOwned::Shared(_))) {
 				return Err(AbortReason::DuplicateFundingOutput);
 			}
-			OutputOwned::Shared(SharedOwnedOutput::new(txout, self.shared_funding_output.1))
+			OutputOwned::Shared(self.shared_funding_output.clone())
 		} else {
 			OutputOwned::Single(txout)
 		};
@@ -793,9 +789,9 @@ impl NegotiationContext {
 
 	fn sent_tx_add_output(&mut self, msg: &msgs::TxAddOutput) -> Result<(), AbortReason> {
 		let txout = TxOut { value: Amount::from_sat(msg.sats), script_pubkey: msg.script.clone() };
-		let output = if txout == self.shared_funding_output.0 {
+		let output = if txout == self.shared_funding_output.tx_out {
 			// this is the shared output
-			OutputOwned::Shared(SharedOwnedOutput::new(txout, self.shared_funding_output.1))
+			OutputOwned::Shared(self.shared_funding_output.clone())
 		} else {
 			OutputOwned::Single(txout)
 		};
@@ -862,7 +858,10 @@ impl NegotiationContext {
 
 		let shared_funding_output = self.shared_funding_output.clone();
 		let constructed_tx = ConstructedTransaction::new(self);
-		if !constructed_tx.outputs.iter().any(|output| *output.tx_out() == shared_funding_output.0)
+		if !constructed_tx
+			.outputs
+			.iter()
+			.any(|output| *output.tx_out() == shared_funding_output.tx_out)
 		{
 			return Err(AbortReason::MissingFundingOutput);
 		}
@@ -1077,7 +1076,8 @@ macro_rules! define_state_machine_transitions {
 impl StateMachine {
 	fn new(
 		holder_node_id: PublicKey, counterparty_node_id: PublicKey, feerate_sat_per_kw: u32,
-		is_initiator: bool, tx_locktime: AbsoluteLockTime, shared_funding_output: (TxOut, u64),
+		is_initiator: bool, tx_locktime: AbsoluteLockTime,
+		shared_funding_output: SharedOwnedOutput,
 	) -> Self {
 		let context = NegotiationContext::new(
 			holder_node_id,
@@ -1183,7 +1183,7 @@ impl_writeable_tlv_based_enum!(InteractiveTxInput,
 );
 
 #[derive(Clone, Debug, Eq, PartialEq)]
-struct SharedOwnedOutput {
+pub(super) struct SharedOwnedOutput {
 	tx_out: TxOut,
 	local_owned: u64,
 }
@@ -1497,7 +1497,7 @@ where
 	pub is_initiator: bool,
 	pub funding_tx_locktime: AbsoluteLockTime,
 	pub inputs_to_contribute: Vec<(TxIn, TransactionU16LenLimited)>,
-	pub shared_funding_output: (TxOut, u64),
+	pub shared_funding_output: SharedOwnedOutput,
 	pub outputs_to_contribute: Vec<TxOut>,
 }
 
@@ -1555,10 +1555,7 @@ impl InteractiveTxConstructor {
 			.collect();
 		if is_initiator {
 			let serial_id = generate_holder_serial_id(entropy_source, is_initiator);
-			let output = OutputOwned::Shared(SharedOwnedOutput::new(
-				shared_funding_output.0,
-				shared_funding_output.1,
-			));
+			let output = OutputOwned::Shared(shared_funding_output);
 			outputs_to_contribute.push((serial_id, output));
 		}
 		// In the same manner and for the same rationale as the inputs above, we'll shuffle the outputs.
@@ -1744,8 +1741,8 @@ mod tests {
 	use crate::ln::interactivetxs::{
 		calculate_change_output_value, generate_holder_serial_id, AbortReason,
 		HandleTxCompleteValue, InteractiveTxConstructor, InteractiveTxConstructorArgs,
-		InteractiveTxMessageSend, MAX_INPUTS_OUTPUTS_COUNT, MAX_RECEIVED_TX_ADD_INPUT_COUNT,
-		MAX_RECEIVED_TX_ADD_OUTPUT_COUNT,
+		InteractiveTxMessageSend, SharedOwnedOutput, MAX_INPUTS_OUTPUTS_COUNT,
+		MAX_RECEIVED_TX_ADD_INPUT_COUNT, MAX_RECEIVED_TX_ADD_OUTPUT_COUNT,
 	};
 	use crate::ln::types::ChannelId;
 	use crate::sign::EntropySource;
@@ -1862,7 +1859,10 @@ mod tests {
 			is_initiator: true,
 			funding_tx_locktime,
 			inputs_to_contribute: session.inputs_a,
-			shared_funding_output: (session.shared_output_a.0, session.shared_output_a.1),
+			shared_funding_output: SharedOwnedOutput::new(
+				session.shared_output_a.0,
+				session.shared_output_a.1,
+			),
 			outputs_to_contribute: session.outputs_a,
 		}) {
 			Ok(r) => r,
@@ -1885,7 +1885,10 @@ mod tests {
 			is_initiator: false,
 			funding_tx_locktime,
 			inputs_to_contribute: session.inputs_b,
-			shared_funding_output: (session.shared_output_b.0, session.shared_output_b.1),
+			shared_funding_output: SharedOwnedOutput::new(
+				session.shared_output_b.0,
+				session.shared_output_b.1,
+			),
 			outputs_to_contribute: session.outputs_b,
 		}) {
 			Ok(r) => r,