Merge pull request #4183 from joostjager/debug-fmt

Add fmt::Debug implementation for FundedChannel

Author: jkczyz

lightning/src/ln/chan_utils.rs

@@ -393,6 +393,7 @@ pub fn build_closing_transaction(to_holder_value_sat: Amount, to_counterparty_va
 /// Allows us to keep track of all of the revocation secrets of our counterparty in just 50*32 bytes
 /// or so.
 #[derive(Clone)]
+#[cfg_attr(test, derive(Debug))]
 pub struct CounterpartyCommitmentSecrets {
 	old_secrets: [([u8; 32], u64); 49],
 }

lightning/src/ln/channel.rs

@@ -138,13 +138,15 @@ enum FeeUpdateState {
 	Outbound,
 }
 
+#[derive(Debug)]
 enum InboundHTLCRemovalReason {
 	FailRelay(msgs::OnionErrorPacket),
 	FailMalformed(([u8; 32], u16)),
 	Fulfill(PaymentPreimage, Option<AttributionData>),
 }
 
 /// Represents the resolution status of an inbound HTLC.
+#[cfg_attr(test, derive(Debug))]
 #[derive(Clone)]
 enum InboundHTLCResolution {
 	/// Resolved implies the action we must take with the inbound HTLC has already been determined,
@@ -168,6 +170,7 @@ impl_writeable_tlv_based_enum!(InboundHTLCResolution,
 	},
 );
 
+#[cfg_attr(test, derive(Debug))]
 enum InboundHTLCState {
 	/// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
 	/// update_add_htlc message for this HTLC.
@@ -295,6 +298,7 @@ impl InboundHTLCState {
 	}
 }
 
+#[cfg_attr(test, derive(Debug))]
 struct InboundHTLCOutput {
 	htlc_id: u64,
 	amount_msat: u64,
@@ -303,7 +307,8 @@ struct InboundHTLCOutput {
 	state: InboundHTLCState,
 }
 
-#[cfg_attr(test, derive(Clone, Debug, PartialEq))]
+#[derive(Debug)]
+#[cfg_attr(test, derive(Clone, PartialEq))]
 enum OutboundHTLCState {
 	/// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
 	/// created it we would have put it in the holding cell instead). When they next revoke_and_ack
@@ -397,8 +402,8 @@ impl OutboundHTLCState {
 	}
 }
 
-#[derive(Clone)]
-#[cfg_attr(test, derive(Debug, PartialEq))]
+#[derive(Clone, Debug)]
+#[cfg_attr(test, derive(PartialEq))]
 enum OutboundHTLCOutcome {
 	/// We started always filling in the preimages here in 0.0.105, and the requirement
 	/// that the preimages always be filled in was added in 0.2.
@@ -415,7 +420,8 @@ impl<'a> Into<Option<&'a HTLCFailReason>> for &'a OutboundHTLCOutcome {
 	}
 }
 
-#[cfg_attr(test, derive(Clone, Debug, PartialEq))]
+#[derive(Debug)]
+#[cfg_attr(test, derive(Clone, PartialEq))]
 struct OutboundHTLCOutput {
 	htlc_id: u64,
 	amount_msat: u64,
@@ -430,7 +436,8 @@ struct OutboundHTLCOutput {
 }
 
 /// See AwaitingRemoteRevoke ChannelState for more info
-#[cfg_attr(test, derive(Clone, Debug, PartialEq))]
+#[derive(Debug)]
+#[cfg_attr(test, derive(Clone, PartialEq))]
 enum HTLCUpdateAwaitingACK {
 	AddHTLC {
 		// TODO: Time out if we're getting close to cltv_expiry
@@ -1013,7 +1020,7 @@ macro_rules! secp_check {
 /// spamming the network with updates if the connection is flapping. Instead, we "stage" updates to
 /// our channel_update message and track the current state here.
 /// See implementation at [`super::channelmanager::ChannelManager::timer_tick_occurred`].
-#[derive(Clone, Copy, PartialEq)]
+#[derive(Clone, Copy, PartialEq, Debug)]
 pub(super) enum ChannelUpdateStatus {
 	/// We've announced the channel as enabled and are connected to our peer.
 	Enabled,
@@ -1026,6 +1033,7 @@ pub(super) enum ChannelUpdateStatus {
 }
 
 /// We track when we sent an `AnnouncementSignatures` to our peer in a few states, described here.
+#[cfg_attr(test, derive(Debug))]
 #[derive(PartialEq)]
 pub enum AnnouncementSigsState {
 	/// We have not sent our peer an `AnnouncementSignatures` yet, or our peer disconnected since
@@ -1395,6 +1403,7 @@ pub(crate) const CHANNEL_ANNOUNCEMENT_PROPAGATION_DELAY: u32 = 14 * 24 * 6 * 4;
 #[cfg(test)]
 pub(crate) const CHANNEL_ANNOUNCEMENT_PROPAGATION_DELAY: u32 = 144;
 
+#[derive(Debug)]
 struct PendingChannelMonitorUpdate {
 	update: ChannelMonitorUpdate,
 }
@@ -2277,6 +2286,7 @@ impl UnfundedChannelContext {
 /// Information pertaining to an attempt at funding the channel. This is typically constructed
 /// during channel establishment and may be replaced during channel splicing or if the attempted
 /// funding transaction is replaced using tx_init_rbf.
+#[derive(Debug)]
 pub(super) struct FundingScope {
 	value_to_self_msat: u64, // Excluding all pending_htlcs, fees, and anchor outputs
 
@@ -2604,6 +2614,7 @@ impl FundingScope {
 /// Information about pending attempts at funding a channel. This includes funding currently under
 /// negotiation and any negotiated attempts waiting enough on-chain confirmations. More than one
 /// such attempt indicates use of RBF to increase the chances of confirmation.
+#[derive(Debug)]
 struct PendingFunding {
 	funding_negotiation: Option<FundingNegotiation>,
 
@@ -2625,6 +2636,7 @@ impl_writeable_tlv_based!(PendingFunding, {
 	(7, received_funding_txid, option),
 });
 
+#[derive(Debug)]
 enum FundingNegotiation {
 	AwaitingAck {
 		context: FundingNegotiationContext,
@@ -2717,6 +2729,7 @@ impl PendingFunding {
 	}
 }
 
+#[derive(Debug)]
 pub(crate) struct SpliceInstructions {
 	adjusted_funding_contribution: SignedAmount,
 	our_funding_inputs: Vec<FundingTxInput>,
@@ -2744,6 +2757,7 @@ impl_writeable_tlv_based!(SpliceInstructions, {
 	(11, locktime, required),
 });
 
+#[derive(Debug)]
 pub(crate) enum QuiescentAction {
 	Splice(SpliceInstructions),
 	#[cfg(any(test, fuzzing))]
@@ -2790,6 +2804,7 @@ impl<'a> From<&'a Transaction> for ConfirmedTransaction<'a> {
 }
 
 /// Contains everything about the channel including state, and various flags.
+#[cfg_attr(test, derive(Debug))]
 pub(super) struct ChannelContext<SP: Deref>
 where
 	SP::Target: SignerProvider,
@@ -6584,6 +6599,7 @@ fn check_v2_funding_inputs_sufficient(
 }
 
 /// Context for negotiating channels (dual-funded V2 open, splicing)
+#[derive(Debug)]
 pub(super) struct FundingNegotiationContext {
 	/// Whether we initiated the funding negotiation.
 	pub is_initiator: bool,
@@ -6723,6 +6739,7 @@ impl FundingNegotiationContext {
 
 // Holder designates channel data owned for the benefit of the user client.
 // Counterparty designates channel data owned by the another channel participant entity.
+#[cfg_attr(test, derive(Debug))]
 pub(super) struct FundedChannel<SP: Deref>
 where
 	SP::Target: SignerProvider,
@@ -6742,7 +6759,7 @@ where
 }
 
 #[cfg(any(test, fuzzing))]
-#[derive(Clone, Copy, Default)]
+#[derive(Clone, Copy, Default, Debug)]
 struct PredictedNextFee {
 	predicted_feerate: u32,
 	predicted_nondust_htlc_count: usize,

lightning/src/ln/channelmanager.rs

@@ -431,13 +431,14 @@ pub struct PendingHTLCInfo {
 	pub skimmed_fee_msat: Option<u64>,
 }
 
-#[derive(Clone)] // See FundedChannel::revoke_and_ack for why, tl;dr: Rust bug
+#[derive(Clone, Debug)] // See FundedChannel::revoke_and_ack for why, tl;dr: Rust bug
 pub(super) enum HTLCFailureMsg {
 	Relay(msgs::UpdateFailHTLC),
 	Malformed(msgs::UpdateFailMalformedHTLC),
 }
 
 /// Stores whether we can't forward an HTLC or relevant forwarding info
+#[cfg_attr(test, derive(Debug))]
 #[derive(Clone)] // See FundedChannel::revoke_and_ack for why, tl;dr: Rust bug
 pub(super) enum PendingHTLCStatus {
 	Forward(PendingHTLCInfo),

lightning/src/ln/interactivetxs.rs

@@ -1893,6 +1893,7 @@ impl InteractiveTxInput {
 	}
 }
 
+#[derive(Debug)]
 pub(super) struct InteractiveTxConstructor {
 	state_machine: StateMachine,
 	is_initiator: bool,
@@ -1905,6 +1906,7 @@ pub(super) struct InteractiveTxConstructor {
 }
 
 #[allow(clippy::enum_variant_names)] // Clippy doesn't like the repeated `Tx` prefix here
+#[derive(Debug)]
 pub(crate) enum InteractiveTxMessageSend {
 	TxAddInput(msgs::TxAddInput),
 	TxAddOutput(msgs::TxAddOutput),

lightning/src/ln/script.rs

@@ -21,6 +21,7 @@ use crate::prelude::*;
 /// A script pubkey for shutting down a channel as defined by [BOLT #2].
 ///
 /// [BOLT #2]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md
+#[cfg_attr(test, derive(Debug))]
 #[derive(Clone, PartialEq, Eq)]
 pub struct ShutdownScript(ShutdownScriptImpl);
 
@@ -33,7 +34,7 @@ pub struct InvalidShutdownScript {
 	pub script: ScriptBuf,
 }
 
-#[derive(Clone, PartialEq, Eq)]
+#[derive(Clone, PartialEq, Eq, Debug)]
 enum ShutdownScriptImpl {
 	/// [`PublicKey`] used to form a P2WPKH script pubkey. Used to support backward-compatible
 	/// serialization.

lightning/src/sign/type_resolver.rs

@@ -12,6 +12,17 @@ where
 	Taproot(<SP::Target as SignerProvider>::TaprootSigner),
 }
 
+#[cfg(test)]
+impl<SP> std::fmt::Debug for ChannelSignerType<SP>
+where
+	SP: Deref,
+	SP::Target: SignerProvider,
+{
+	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+		f.debug_struct("ChannelSignerType").finish()
+	}
+}
+
 impl<SP: Deref> ChannelSignerType<SP>
 where
 	SP::Target: SignerProvider,

lightning/src/util/test_utils.rs

@@ -1807,6 +1807,12 @@ pub struct TestKeysInterface {
 	pub override_next_keys_id: Mutex<Option<[u8; 32]>>,
 }
 
+impl std::fmt::Debug for TestKeysInterface {
+	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+		f.debug_struct("TestKeysInterface").finish()
+	}
+}
+
 impl EntropySource for TestKeysInterface {
 	fn get_secure_random_bytes(&self) -> [u8; 32] {
 		let override_random_bytes = self.override_random_bytes.lock().unwrap();