From: Duncan Dean <git@dunxen.dev>
Date: Wed, 26 Jul 2023 09:20:08 +0000 (+0200)
Subject: Introduce `ChannelPhase` enum
X-Git-Tag: v0.0.117-alpha1~21^2~2
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=585188cda35c229212bf68c338ac81b8a9d4899b;p=rust-lightning

Introduce `ChannelPhase` enum

We introduce the `ChannelPhase` enum which will contain the different
channel structs wrapped by each of its variants so that we can place
these within a single `channel_by_id` map in `peer_state` in the
following commits. This will reduce the number of map lookup operations
we need to do in `ChannelManager`'s various methods. It will also make
certain channel counting logic easier to reason about with less risk of
forgetting to modify logic when new channels structs are introduced for
V2 channel establishment.
---

diff --git a/lightning/src/ln/channel.rs b/lightning/src/ln/channel.rs
index 659c8114..796c041f 100644
--- a/lightning/src/ln/channel.rs
+++ b/lightning/src/ln/channel.rs
@@ -605,6 +605,35 @@ impl_writeable_tlv_based!(PendingChannelMonitorUpdate, {
 	(0, update, required),
 });
 
+/// The `ChannelPhase` enum describes the current phase in life of a lightning channel with each of
+/// its variants containing an appropriate channel struct.
+pub(super) enum ChannelPhase<SP: Deref> where SP::Target: SignerProvider {
+	UnfundedOutboundV1(OutboundV1Channel<SP>),
+	UnfundedInboundV1(InboundV1Channel<SP>),
+	Funded(Channel<SP>),
+}
+
+impl<'a, SP: Deref> ChannelPhase<SP> where
+	SP::Target: SignerProvider,
+	<SP::Target as SignerProvider>::Signer: ChannelSigner,
+{
+	pub fn context(&'a self) -> &'a ChannelContext<SP> {
+		match self {
+			ChannelPhase::Funded(chan) => &chan.context,
+			ChannelPhase::UnfundedOutboundV1(chan) => &chan.context,
+			ChannelPhase::UnfundedInboundV1(chan) => &chan.context,
+		}
+	}
+
+	pub fn context_mut(&'a mut self) -> &'a mut ChannelContext<SP> {
+		match self {
+			ChannelPhase::Funded(ref mut chan) => &mut chan.context,
+			ChannelPhase::UnfundedOutboundV1(ref mut chan) => &mut chan.context,
+			ChannelPhase::UnfundedInboundV1(ref mut chan) => &mut chan.context,
+		}
+	}
+}
+
 /// Contains all state common to unfunded inbound/outbound channels.
 pub(super) struct UnfundedChannelContext {
 	/// A counter tracking how many ticks have elapsed since this unfunded channel was