ChannelState serialization

Author: wvanlint

lightning/src/ln/channel.rs

@@ -255,6 +255,7 @@ enum HTLCUpdateAwaitingACK {
 /// Note that `PeerDisconnected` can be set on both `ChannelReady` and `FundingSent`.
 /// `ChannelReady` can then get all remaining flags set on it, until we finish shutdown, then we
 /// move on to `ShutdownComplete`, at which point most calls into this channel are disallowed.
+#[derive(Clone, Copy)]
 enum ChannelState {
 	/// Implies we have (or are prepared to) send our open_channel/accept_channel message
 	OurInitSent = 1 << 0,
@@ -318,6 +319,54 @@ const STATE_FLAGS: u32 =
 	ChannelState::OurChannelReady as u32 |
 	ChannelState::AwaitingRemoteRevoke as u32 |
 	ChannelState::WaitingForBatch as u32;
+const CHANNEL_STATE_ENUMS: [ChannelState; 14] = [
+	ChannelState::OurInitSent,
+	ChannelState::TheirInitSent,
+	ChannelState::FundingCreated,
+	ChannelState::FundingSent,
+	ChannelState::TheirChannelReady,
+	ChannelState::OurChannelReady,
+	ChannelState::ChannelReady,
+	ChannelState::PeerDisconnected,
+	ChannelState::MonitorUpdateInProgress,
+	ChannelState::AwaitingRemoteRevoke,
+	ChannelState::RemoteShutdownSent,
+	ChannelState::LocalShutdownSent,
+	ChannelState::ShutdownComplete,
+	ChannelState::WaitingForBatch,
+];
+
+struct ChannelStateInt(u32);
+
+impl IntoIterator for ChannelStateInt {
+	type Item = ChannelState;
+	type IntoIter = Box<dyn Iterator<Item = ChannelState>>;
+
+	fn into_iter(self) -> Self::IntoIter {
+		Box::new(
+			CHANNEL_STATE_ENUMS.iter()
+			.filter(move |&channel_state| self.0 & *channel_state as u32 != 0)
+			.map(|channel_state| channel_state.clone())
+		)
+	}
+}
+
+impl_writeable_tlv_based_enum_upgradable!(ChannelState,
+	(0, OurInitSent) => {},
+	(2, TheirInitSent) => {},
+	(4, FundingCreated) => {},
+	(6, FundingSent) => {},
+	(8, TheirChannelReady) => {},
+	(10, OurChannelReady) => {},
+	(12, ChannelReady) => {},
+	(14, PeerDisconnected) => {},
+	(16, MonitorUpdateInProgress) => {},
+	(18, AwaitingRemoteRevoke) => {},
+	(20, RemoteShutdownSent) => {},
+	(22, LocalShutdownSent) => {},
+	(24, ShutdownComplete) => {},
+	(26, WaitingForBatch) => {},
+);
 
 pub const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
 
@@ -7033,6 +7082,11 @@ impl<SP: Deref> Writeable for Channel<SP> where SP::Target: SignerProvider {
 			(31, channel_pending_event_emitted, option),
 			(35, pending_outbound_skimmed_fees, optional_vec),
 			(37, holding_cell_skimmed_fees, optional_vec),
+			(
+				if self.context.channel_state & ChannelState::WaitingForBatch as u32 != 0 { 38 } else { 39 },
+				ChannelStateInt(self.context.channel_state).into_iter().collect::<Vec<ChannelState>>(),
+				optional_vec
+			),
 		});
 
 		Ok(())
@@ -7317,6 +7371,9 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 		let mut pending_outbound_skimmed_fees_opt: Option<Vec<Option<u64>>> = None;
 		let mut holding_cell_skimmed_fees_opt: Option<Vec<Option<u64>>> = None;
 
+		let mut _channel_states_even: Option<Vec<ChannelState>>;
+		let mut _channel_states_uneven: Option<Vec<ChannelState>>;
+
 		read_tlv_fields!(reader, {
 			(0, announcement_sigs, option),
 			(1, minimum_depth, option),
@@ -7342,6 +7399,8 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
 			(31, channel_pending_event_emitted, option),
 			(35, pending_outbound_skimmed_fees_opt, optional_vec),
 			(37, holding_cell_skimmed_fees_opt, optional_vec),
+			(38, _channel_states_even, optional_vec),
+			(39, _channel_states_uneven, optional_vec),
 		});
 
 		let (channel_keys_id, holder_signer) = if let Some(channel_keys_id) = channel_keys_id {