f - use ChannelReady instead of SpliceLocked event

Author: jkczyz

lightning/src/events/mod.rs

@@ -1293,10 +1293,13 @@ pub enum Event {
 		/// Will be `None` for channels created prior to LDK version 0.0.122.
 		channel_type: Option<ChannelTypeFeatures>,
 	},
-	/// Used to indicate that a channel with the given `channel_id` is ready to
-	/// be used. This event is emitted either when the funding transaction has been confirmed
-	/// on-chain, or, in case of a 0conf channel, when both parties have confirmed the channel
-	/// establishment.
+	/// Used to indicate that a channel with the given `channel_id` is ready to be used. This event
+	/// is emitted when
+	/// - the initial funding transaction has been confirmed on-chain to an acceptable depth
+	///   according to both parties (i.e., `channel_ready` messages were exchanged),
+	/// - a splice funding transaction has been confirmed on-chain to an acceptable depth according
+	///   to both parties (i.e., `splice_locked` messages were exchanged), or,
+	/// - in case of a 0conf channel, when both parties have confirmed the channel establishment.
 	///
 	/// # Failure Behavior and Persistence
 	/// This event will eventually be replayed after failures-to-handle (i.e., the event handler
@@ -1318,31 +1321,6 @@ pub enum Event {
 		/// The features that this channel will operate with.
 		channel_type: ChannelTypeFeatures,
 	},
-	/// Used to indicate that a channel with the given `channel_id` has had its funding spliced.
-	/// This event is emitted when the splice transaction has been confirmed on-chain to a
-	/// sufficient depth by both parties, or, in case of a 0-conf channel, when both parties have
-	/// completed negotiation of the splice transaction.
-	///
-	/// # Failure Behavior and Persistence
-	/// This event will eventually be replayed after failures-to-handle (i.e., the event handler
-	/// returning `Err(ReplayEvent ())`) and will be persisted across restarts.
-	SpliceLocked {
-		/// The `channel_id` of the channel that had its funding spliced.
-		channel_id: ChannelId,
-		/// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
-		/// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
-		/// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
-		/// `user_channel_id` will be randomized for an inbound channel.
-		///
-		/// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
-		/// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
-		/// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
-		user_channel_id: u128,
-		/// The `node_id` of the channel counterparty.
-		counterparty_node_id: PublicKey,
-		/// The features that this channel will operate with.
-		channel_type: ChannelTypeFeatures,
-	},
 	/// Used to indicate that a channel that got past the initial handshake with the given `channel_id` is in the
 	/// process of closure. This includes previously opened channels, and channels that time out from not being funded.
 	///
@@ -1867,15 +1845,6 @@ impl Writeable for Event {
 					(8, former_temporary_channel_id, required),
 				});
 			},
-			&Event::SpliceLocked { ref channel_id, ref user_channel_id, ref counterparty_node_id, ref channel_type } => {
-				45u8.write(writer)?;
-				write_tlv_fields!(writer, {
-					(0, channel_id, required),
-					(2, user_channel_id, required),
-					(4, counterparty_node_id, required),
-					(6, channel_type, required),
-				});
-			},
 			// Note that, going forward, all new events must only write data inside of
 			// `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
 			// data via `write_tlv_fields`.
@@ -2392,28 +2361,6 @@ impl MaybeReadable for Event {
 					former_temporary_channel_id: former_temporary_channel_id.0.unwrap(),
 				}))
 			},
-			45u8 => {
-				let mut f = || {
-					let mut channel_id = ChannelId::new_zero();
-					let mut user_channel_id: u128 = 0;
-					let mut counterparty_node_id = RequiredWrapper(None);
-					let mut channel_type = RequiredWrapper(None);
-					read_tlv_fields!(reader, {
-						(0, channel_id, required),
-						(2, user_channel_id, required),
-						(4, counterparty_node_id, required),
-						(6, channel_type, required),
-					});
-
-					Ok(Some(Event::SpliceLocked {
-						channel_id,
-						user_channel_id,
-						counterparty_node_id: counterparty_node_id.0.unwrap(),
-						channel_type: channel_type.0.unwrap()
-					}))
-				};
-				f()
-			},
 			// Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
 			// Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
 			// reads.

lightning/src/ln/channel.rs

@@ -2139,8 +2139,8 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
 	// We track whether we already emitted a `FundingTxBroadcastSafe` event.
 	funding_tx_broadcast_safe_event_emitted: bool,
 
-	// We track whether we already emitted a `ChannelReady` event.
-	channel_ready_event_emitted: bool,
+	// We track whether we already emitted an initial `ChannelReady` event.
+	initial_channel_ready_event_emitted: bool,
 
 	/// Some if we initiated to shut down the channel.
 	local_initiated_shutdown: Option<()>,
@@ -2948,7 +2948,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 
 			channel_pending_event_emitted: false,
 			funding_tx_broadcast_safe_event_emitted: false,
-			channel_ready_event_emitted: false,
+			initial_channel_ready_event_emitted: false,
 
 			channel_keys_id,
 
@@ -3184,7 +3184,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 
 			channel_pending_event_emitted: false,
 			funding_tx_broadcast_safe_event_emitted: false,
-			channel_ready_event_emitted: false,
+			initial_channel_ready_event_emitted: false,
 
 			channel_keys_id,
 
@@ -3608,14 +3608,14 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 		self.channel_pending_event_emitted = true;
 	}
 
-	// Checks whether we should emit a `ChannelReady` event.
-	pub(crate) fn should_emit_channel_ready_event(&mut self) -> bool {
-		self.is_usable() && !self.channel_ready_event_emitted
+	// Checks whether we should emit an initial `ChannelReady` event.
+	pub(crate) fn should_emit_initial_channel_ready_event(&mut self) -> bool {
+		self.is_usable() && !self.initial_channel_ready_event_emitted
 	}
 
 	// Remembers that we already emitted a `ChannelReady` event.
-	pub(crate) fn set_channel_ready_event_emitted(&mut self) {
-		self.channel_ready_event_emitted = true;
+	pub(crate) fn set_initial_channel_ready_event_emitted(&mut self) {
+		self.initial_channel_ready_event_emitted = true;
 	}
 
 	// Remembers that we already emitted a `FundingTxBroadcastSafe` event.
@@ -11087,7 +11087,7 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 			{ Some(self.context.holder_max_htlc_value_in_flight_msat) } else { None };
 
 		let channel_pending_event_emitted = Some(self.context.channel_pending_event_emitted);
-		let channel_ready_event_emitted = Some(self.context.channel_ready_event_emitted);
+		let initial_channel_ready_event_emitted = Some(self.context.initial_channel_ready_event_emitted);
 		let funding_tx_broadcast_safe_event_emitted = Some(self.context.funding_tx_broadcast_safe_event_emitted);
 
 		// `user_id` used to be a single u64 value. In order to remain backwards compatible with
@@ -11131,7 +11131,7 @@ impl<SP: Deref> Writeable for FundedChannel<SP> where SP::Target: SignerProvider
 			(17, self.context.announcement_sigs_state, required),
 			(19, self.context.latest_inbound_scid_alias, option),
 			(21, self.context.outbound_scid_alias, required),
-			(23, channel_ready_event_emitted, option),
+			(23, initial_channel_ready_event_emitted, option),
 			(25, user_id_high_opt, option),
 			(27, self.context.channel_keys_id, required),
 			(28, holder_max_accepted_htlcs, option),
@@ -11418,7 +11418,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 		let mut latest_inbound_scid_alias = None;
 		let mut outbound_scid_alias = 0u64;
 		let mut channel_pending_event_emitted = None;
-		let mut channel_ready_event_emitted = None;
+		let mut initial_channel_ready_event_emitted = None;
 		let mut funding_tx_broadcast_safe_event_emitted = None;
 
 		let mut user_id_high_opt: Option<u64> = None;
@@ -11468,7 +11468,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 			(17, announcement_sigs_state, required),
 			(19, latest_inbound_scid_alias, option),
 			(21, outbound_scid_alias, required),
-			(23, channel_ready_event_emitted, option),
+			(23, initial_channel_ready_event_emitted, option),
 			(25, user_id_high_opt, option),
 			(27, channel_keys_id, required),
 			(28, holder_max_accepted_htlcs, option),
@@ -11763,7 +11763,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, &'c Channel
 
 				funding_tx_broadcast_safe_event_emitted: funding_tx_broadcast_safe_event_emitted.unwrap_or(false),
 				channel_pending_event_emitted: channel_pending_event_emitted.unwrap_or(true),
-				channel_ready_event_emitted: channel_ready_event_emitted.unwrap_or(true),
+				initial_channel_ready_event_emitted: initial_channel_ready_event_emitted.unwrap_or(true),
 
 				channel_keys_id,
 

lightning/src/ln/channelmanager.rs

@@ -3193,17 +3193,17 @@ macro_rules! emit_channel_pending_event {
 	}
 }
 
-macro_rules! emit_channel_ready_event {
+macro_rules! emit_initial_channel_ready_event {
 	($locked_events: expr, $channel: expr) => {
-		if $channel.context.should_emit_channel_ready_event() {
+		if $channel.context.should_emit_initial_channel_ready_event() {
 			debug_assert!($channel.context.channel_pending_event_emitted());
 			$locked_events.push_back((events::Event::ChannelReady {
 				channel_id: $channel.context.channel_id(),
 				user_channel_id: $channel.context.get_user_id(),
 				counterparty_node_id: $channel.context.get_counterparty_node_id(),
 				channel_type: $channel.funding.get_channel_type().clone(),
 			}, None));
-			$channel.context.set_channel_ready_event_emitted();
+			$channel.context.set_initial_channel_ready_event_emitted();
 		}
 	}
 }
@@ -7751,7 +7751,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 		{
 			let mut pending_events = self.pending_events.lock().unwrap();
 			emit_channel_pending_event!(pending_events, channel);
-			emit_channel_ready_event!(pending_events, channel);
+			emit_initial_channel_ready_event!(pending_events, channel);
 		}
 
 		(htlc_forwards, decode_update_add_htlcs)
@@ -8704,7 +8704,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 
 					{
 						let mut pending_events = self.pending_events.lock().unwrap();
-						emit_channel_ready_event!(pending_events, chan);
+						emit_initial_channel_ready_event!(pending_events, chan);
 					}
 
 					Ok(())
@@ -9641,7 +9641,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 						insert_short_channel_id!(short_to_chan_info, chan);
 
 						let mut pending_events = self.pending_events.lock().unwrap();
-						pending_events.push_back((events::Event::SpliceLocked {
+						pending_events.push_back((events::Event::ChannelReady {
 							channel_id: chan.context.channel_id(),
 							user_channel_id: chan.context.get_user_id(),
 							counterparty_node_id: chan.context.get_counterparty_node_id(),
@@ -11788,7 +11788,7 @@ where
 											insert_short_channel_id!(short_to_chan_info, funded_channel);
 
 											let mut pending_events = self.pending_events.lock().unwrap();
-											pending_events.push_back((events::Event::SpliceLocked {
+											pending_events.push_back((events::Event::ChannelReady {
 												channel_id: funded_channel.context.channel_id(),
 												user_channel_id: funded_channel.context.get_user_id(),
 												counterparty_node_id: funded_channel.context.get_counterparty_node_id(),
@@ -11806,7 +11806,7 @@ where
 
 								{
 									let mut pending_events = self.pending_events.lock().unwrap();
-									emit_channel_ready_event!(pending_events, funded_channel);
+									emit_initial_channel_ready_event!(pending_events, funded_channel);
 								}
 
 								if let Some(height) = height_opt {