Move ChannelContext::funding_tx_confirmation_height to FundingScope

When processing confirmed transactions, if the funding transaction is
found then information about it in the ChannelContext is updated. In
preparation for splicing, move this data to FundingScope.

Author: jkczyz

lightning/src/ln/channel.rs

@@ -1687,6 +1687,7 @@ pub(super) struct FundingScope {
 	funding_transaction: Option<Transaction>,
 	/// The hash of the block in which the funding transaction was included.
 	funding_tx_confirmed_in: Option<BlockHash>,
+	funding_tx_confirmation_height: u32,
 }
 
 impl Writeable for FundingScope {
@@ -1698,6 +1699,7 @@ impl Writeable for FundingScope {
 			(7, self.channel_transaction_parameters, (required: ReadableArgs, None)),
 			(9, self.funding_transaction, option),
 			(11, self.funding_tx_confirmed_in, option),
+			(13, self.funding_tx_confirmation_height, required),
 		});
 		Ok(())
 	}
@@ -1711,6 +1713,7 @@ impl Readable for FundingScope {
 		let mut channel_transaction_parameters = RequiredWrapper(None);
 		let mut funding_transaction = None;
 		let mut funding_tx_confirmed_in = None;
+		let mut funding_tx_confirmation_height = RequiredWrapper(None);
 
 		read_tlv_fields!(reader, {
 			(1, value_to_self_msat, required),
@@ -1719,6 +1722,7 @@ impl Readable for FundingScope {
 			(7, channel_transaction_parameters, (required: ReadableArgs, None)),
 			(9, funding_transaction, option),
 			(11, funding_tx_confirmed_in, option),
+			(13, funding_tx_confirmation_height, required),
 		});
 
 		Ok(Self {
@@ -1732,6 +1736,7 @@ impl Readable for FundingScope {
 			channel_transaction_parameters: channel_transaction_parameters.0.unwrap(),
 			funding_transaction,
 			funding_tx_confirmed_in,
+			funding_tx_confirmation_height: funding_tx_confirmation_height.0.unwrap(),
 			#[cfg(any(test, fuzzing))]
 			next_local_commitment_tx_fee_info_cached: Mutex::new(None),
 			#[cfg(any(test, fuzzing))]
@@ -1810,6 +1815,26 @@ impl FundingScope {
 	pub fn get_funding_tx_confirmed_in(&self) -> Option<BlockHash> {
 		self.funding_tx_confirmed_in
 	}
+
+	/// Returns the height in which our funding transaction was confirmed.
+	pub fn get_funding_tx_confirmation_height(&self) -> Option<u32> {
+		let conf_height = self.funding_tx_confirmation_height;
+		if conf_height > 0 {
+			Some(conf_height)
+		} else {
+			None
+		}
+	}
+
+	/// Returns the current number of confirmations on the funding transaction.
+	pub fn get_funding_tx_confirmations(&self, height: u32) -> u32 {
+		if self.funding_tx_confirmation_height == 0 {
+			// We either haven't seen any confirmation yet, or observed a reorg.
+			return 0;
+		}
+
+		height.checked_sub(self.funding_tx_confirmation_height).map_or(0, |c| c + 1)
+	}
 }
 
 /// Info about a pending splice, used in the pre-splice channel
@@ -1969,7 +1994,6 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
 	/// milliseconds, so any accidental force-closes here should be exceedingly rare.
 	expecting_peer_commitment_signed: bool,
 
-	funding_tx_confirmation_height: u32,
 	short_channel_id: Option<u64>,
 	/// Either the height at which this channel was created or the height at which it was last
 	/// serialized if it was serialized by versions prior to 0.0.103.
@@ -2780,6 +2804,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 			},
 			funding_transaction: None,
 			funding_tx_confirmed_in: None,
+			funding_tx_confirmation_height: 0,
 		};
 		let channel_context = ChannelContext {
 			user_id,
@@ -2843,7 +2868,6 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 			closing_fee_limits: None,
 			target_closing_feerate_sats_per_kw: None,
 
-			funding_tx_confirmation_height: 0,
 			short_channel_id: None,
 			channel_creation_height: current_chain_height,
 
@@ -3016,6 +3040,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 			},
 			funding_transaction: None,
 			funding_tx_confirmed_in: None,
+			funding_tx_confirmation_height: 0,
 		};
 		let channel_context = Self {
 			user_id,
@@ -3077,7 +3102,6 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 			closing_fee_limits: None,
 			target_closing_feerate_sats_per_kw: None,
 
-			funding_tx_confirmation_height: 0,
 			short_channel_id: None,
 			channel_creation_height: current_chain_height,
 
@@ -3319,16 +3343,6 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 		self.outbound_scid_alias = outbound_scid_alias;
 	}
 
-	/// Returns the height in which our funding transaction was confirmed.
-	pub fn get_funding_tx_confirmation_height(&self) -> Option<u32> {
-		let conf_height = self.funding_tx_confirmation_height;
-		if conf_height > 0 {
-			Some(conf_height)
-		} else {
-			None
-		}
-	}
-
 	/// Performs checks against necessary constraints after receiving either an `accept_channel` or
 	/// `accept_channel2` message.
 	pub fn do_accept_channel_checks(
@@ -3469,16 +3483,6 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 		Ok(())
 	}
 
-	/// Returns the current number of confirmations on the funding transaction.
-	pub fn get_funding_tx_confirmations(&self, height: u32) -> u32 {
-		if self.funding_tx_confirmation_height == 0 {
-			// We either haven't seen any confirmation yet, or observed a reorg.
-			return 0;
-		}
-
-		height.checked_sub(self.funding_tx_confirmation_height).map_or(0, |c| c + 1)
-	}
-
 	/// Allowed in any state (including after shutdown)
 	pub fn get_counterparty_node_id(&self) -> PublicKey {
 		self.counterparty_node_id
@@ -4887,7 +4891,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 		NS::Target: NodeSigner,
 		L::Target: Logger
 	{
-		if self.funding_tx_confirmation_height == 0 || self.funding_tx_confirmation_height + 5 > best_block_height {
+		if funding.funding_tx_confirmation_height == 0 || funding.funding_tx_confirmation_height + 5 > best_block_height {
 			return None;
 		}
 
@@ -6843,7 +6847,7 @@ impl<SP: Deref> FundedChannel<SP> where
 				matches!(self.context.channel_state, ChannelState::ChannelReady(_)))
 			{
 				// Broadcast only if not yet confirmed
-				if self.context.get_funding_tx_confirmation_height().is_none() {
+				if self.funding.get_funding_tx_confirmation_height().is_none() {
 					funding_broadcastable = Some(funding_transaction.clone())
 				}
 			}
@@ -8179,13 +8183,13 @@ impl<SP: Deref> FundedChannel<SP> where
 		// Called:
 		//  * always when a new block/transactions are confirmed with the new height
 		//  * when funding is signed with a height of 0
-		if self.context.funding_tx_confirmation_height == 0 && self.context.minimum_depth != Some(0) {
+		if self.funding.funding_tx_confirmation_height == 0 && self.context.minimum_depth != Some(0) {
 			return None;
 		}
 
-		let funding_tx_confirmations = height as i64 - self.context.funding_tx_confirmation_height as i64 + 1;
+		let funding_tx_confirmations = height as i64 - self.funding.funding_tx_confirmation_height as i64 + 1;
 		if funding_tx_confirmations <= 0 {
-			self.context.funding_tx_confirmation_height = 0;
+			self.funding.funding_tx_confirmation_height = 0;
 		}
 
 		if funding_tx_confirmations < self.context.minimum_depth.unwrap_or(0) as i64 {
@@ -8205,7 +8209,7 @@ impl<SP: Deref> FundedChannel<SP> where
 			// We got a reorg but not enough to trigger a force close, just ignore.
 			false
 		} else {
-			if self.context.funding_tx_confirmation_height != 0 &&
+			if self.funding.funding_tx_confirmation_height != 0 &&
 				self.context.channel_state < ChannelState::ChannelReady(ChannelReadyFlags::new())
 			{
 				// We should never see a funding transaction on-chain until we've received
@@ -8277,7 +8281,7 @@ impl<SP: Deref> FundedChannel<SP> where
 			for &(index_in_block, tx) in txdata.iter() {
 				// Check if the transaction is the expected funding transaction, and if it is,
 				// check that it pays the right amount to the right script.
-				if self.context.funding_tx_confirmation_height == 0 {
+				if self.funding.funding_tx_confirmation_height == 0 {
 					if tx.compute_txid() == funding_txo.txid {
 						let txo_idx = funding_txo.index as usize;
 						if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.funding.get_funding_redeemscript().to_p2wsh() ||
@@ -8308,7 +8312,7 @@ impl<SP: Deref> FundedChannel<SP> where
 								}
 							}
 
-							self.context.funding_tx_confirmation_height = height;
+							self.funding.funding_tx_confirmation_height = height;
 							self.funding.funding_tx_confirmed_in = Some(*block_hash);
 							self.context.short_channel_id = match scid_from_parts(height as u64, index_in_block as u64, txo_idx as u64) {
 								Ok(scid) => Some(scid),
@@ -8409,8 +8413,8 @@ impl<SP: Deref> FundedChannel<SP> where
 
 		if matches!(self.context.channel_state, ChannelState::ChannelReady(_)) ||
 			self.context.channel_state.is_our_channel_ready() {
-			let mut funding_tx_confirmations = height as i64 - self.context.funding_tx_confirmation_height as i64 + 1;
-			if self.context.funding_tx_confirmation_height == 0 {
+			let mut funding_tx_confirmations = height as i64 - self.funding.funding_tx_confirmation_height as i64 + 1;
+			if self.funding.funding_tx_confirmation_height == 0 {
 				// Note that check_get_channel_ready may reset funding_tx_confirmation_height to
 				// zero if it has been reorged out, however in either case, our state flags
 				// indicate we've already sent a channel_ready
@@ -8450,10 +8454,10 @@ impl<SP: Deref> FundedChannel<SP> where
 	/// force-close the channel, but may also indicate a harmless reorganization of a block or two
 	/// before the channel has reached channel_ready and we can just wait for more blocks.
 	pub fn funding_transaction_unconfirmed<L: Deref>(&mut self, logger: &L) -> Result<(), ClosureReason> where L::Target: Logger {
-		if self.context.funding_tx_confirmation_height != 0 {
+		if self.funding.funding_tx_confirmation_height != 0 {
 			// We handle the funding disconnection by calling best_block_updated with a height one
 			// below where our funding was connected, implying a reorg back to conf_height - 1.
-			let reorg_height = self.context.funding_tx_confirmation_height - 1;
+			let reorg_height = self.funding.funding_tx_confirmation_height - 1;
 			// We use the time field to bump the current time we set on channel updates if its
 			// larger. If we don't know that time has moved forward, we can just set it to the last
 			// time we saw and it will be ignored.
@@ -8562,7 +8566,7 @@ impl<SP: Deref> FundedChannel<SP> where
 		}
 
 		self.context.announcement_sigs = Some((msg.node_signature, msg.bitcoin_signature));
-		if self.context.funding_tx_confirmation_height == 0 || self.context.funding_tx_confirmation_height + 5 > best_block_height {
+		if self.funding.funding_tx_confirmation_height == 0 || self.funding.funding_tx_confirmation_height + 5 > best_block_height {
 			return Err(ChannelError::Ignore(
 				"Got announcement_signatures prior to the required six confirmations - we may not have received a block yet that our peer has".to_owned()));
 		}
@@ -8575,7 +8579,7 @@ impl<SP: Deref> FundedChannel<SP> where
 	pub fn get_signed_channel_announcement<NS: Deref>(
 		&self, node_signer: &NS, chain_hash: ChainHash, best_block_height: u32, user_config: &UserConfig
 	) -> Option<msgs::ChannelAnnouncement> where NS::Target: NodeSigner {
-		if self.context.funding_tx_confirmation_height == 0 || self.context.funding_tx_confirmation_height + 5 > best_block_height {
+		if self.funding.funding_tx_confirmation_height == 0 || self.funding.funding_tx_confirmation_height + 5 > best_block_height {
 			return None;
 		}
 		let announcement = match self.get_channel_announcement(node_signer, chain_hash, user_config) {
@@ -10725,7 +10729,7 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 		0u8.write(writer)?;
 
 		self.funding.funding_tx_confirmed_in.write(writer)?;
-		self.context.funding_tx_confirmation_height.write(writer)?;
+		self.funding.funding_tx_confirmation_height.write(writer)?;
 		self.context.short_channel_id.write(writer)?;
 
 		self.context.counterparty_dust_limit_satoshis.write(writer)?;
@@ -11361,6 +11365,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 				channel_transaction_parameters: channel_parameters,
 				funding_transaction,
 				funding_tx_confirmed_in,
+				funding_tx_confirmation_height,
 			},
 			pending_funding: pending_funding.unwrap(),
 			context: ChannelContext {
@@ -11424,7 +11429,6 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 				closing_fee_limits: None,
 				target_closing_feerate_sats_per_kw,
 
-				funding_tx_confirmation_height,
 				short_channel_id,
 				channel_creation_height,
 

lightning/src/ln/channel_state.rs

@@ -532,7 +532,7 @@ impl ChannelDetails {
 			next_outbound_htlc_minimum_msat: balance.next_outbound_htlc_minimum_msat,
 			user_channel_id: context.get_user_id(),
 			confirmations_required: context.minimum_depth(),
-			confirmations: Some(context.get_funding_tx_confirmations(best_block_height)),
+			confirmations: Some(funding.get_funding_tx_confirmations(best_block_height)),
 			force_close_spend_delay: funding.get_counterparty_selected_contest_delay(),
 			is_outbound: funding.is_outbound(),
 			is_channel_ready: context.is_usable(),