Manually implement display for entities in common that own ProtocolKeys

This allow to simplify the default display by removing all of those keys
from the output.
We can still show them by using the "alternate"/pretty-print debug
display.

Author: Alenar

mithril-common/src/entities/certificate.rs

@@ -3,6 +3,7 @@ use crate::entities::{
     Beacon, CertificateMetadata, HexEncodedAgregateVerificationKey, ProtocolMessage,
 };
 use std::cmp::Ordering;
+use std::fmt::{Debug, Formatter};
 
 use sha2::{Digest, Sha256};
 
@@ -19,7 +20,7 @@ pub enum CertificateSignature {
 }
 
 /// Certificate represents a Mithril certificate embedding a Mithril STM multisignature
-#[derive(Clone, Debug)]
+#[derive(Clone)]
 pub struct Certificate {
     /// Hash of the current certificate
     /// Computed from the other fields of the certificate
@@ -133,6 +134,34 @@ impl PartialOrd for Certificate {
     }
 }
 
+impl Debug for Certificate {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        let should_be_exhaustive = f.alternate();
+        let mut debug = f.debug_struct("Certificate");
+        debug
+            .field("hash", &self.hash)
+            .field("previous_hash", &self.previous_hash)
+            .field("beacon", &format_args!("{:?}", self.beacon))
+            .field("metadata", &format_args!("{:?}", self.metadata))
+            .field(
+                "protocol_message",
+                &format_args!("{:?}", self.protocol_message),
+            )
+            .field("signed_message", &self.signed_message);
+
+        match should_be_exhaustive {
+            true => debug
+                .field(
+                    "aggregate_verification_key",
+                    &format_args!("{:?}", self.aggregate_verification_key),
+                )
+                .field("signature", &format_args!("{:?}", self.signature))
+                .finish(),
+            false => debug.finish_non_exhaustive(),
+        }
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

mithril-common/src/entities/signer.rs

@@ -5,12 +5,13 @@ use crate::{
     },
     entities::{PartyId, Stake},
 };
+use std::fmt::{Debug, Formatter};
 
 use serde::{Deserialize, Serialize};
 use sha2::{Digest, Sha256};
 
 /// Signer represents a signing participant in the network
-#[derive(Clone, Debug, Eq, Serialize, Deserialize)]
+#[derive(Clone, Eq, Serialize, Deserialize)]
 pub struct Signer {
     /// The unique identifier of the signer
     // TODO: Should be removed once the signer certification is fully deployed
@@ -75,6 +76,33 @@ impl Signer {
     }
 }
 
+impl Debug for Signer {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        let should_be_exhaustive = f.alternate();
+        let mut debug = f.debug_struct("Signer");
+        debug.field("party_id", &self.party_id);
+
+        match should_be_exhaustive {
+            true => debug
+                .field(
+                    "verification_key",
+                    &format_args!("{:?}", self.verification_key),
+                )
+                .field(
+                    "verification_key_signature",
+                    &format_args!("{:?}", self.verification_key_signature),
+                )
+                .field(
+                    "operational_certificate",
+                    &format_args!("{:?}", self.operational_certificate),
+                )
+                .field("kes_period", &format_args!("{:?}", self.kes_period))
+                .finish(),
+            false => debug.finish_non_exhaustive(),
+        }
+    }
+}
+
 impl From<SignerWithStake> for Signer {
     fn from(other: SignerWithStake) -> Self {
         Signer::new(
@@ -88,7 +116,7 @@ impl From<SignerWithStake> for Signer {
 }
 
 /// Signer represents a signing party in the network (including its stakes)
-#[derive(Clone, Debug, Eq, Serialize, Deserialize)]
+#[derive(Clone, Eq, Serialize, Deserialize)]
 pub struct SignerWithStake {
     /// The unique identifier of the signer
     // TODO: Should be removed once the signer certification is fully deployed
@@ -184,6 +212,35 @@ impl SignerWithStake {
     }
 }
 
+impl Debug for SignerWithStake {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        let should_be_exhaustive = f.alternate();
+        let mut debug = f.debug_struct("SignerWithStake");
+        debug
+            .field("party_id", &self.party_id)
+            .field("stake", &self.stake);
+
+        match should_be_exhaustive {
+            true => debug
+                .field(
+                    "verification_key",
+                    &format_args!("{:?}", self.verification_key),
+                )
+                .field(
+                    "verification_key_signature",
+                    &format_args!("{:?}", self.verification_key_signature),
+                )
+                .field(
+                    "operational_certificate",
+                    &format_args!("{:?}", self.operational_certificate),
+                )
+                .field("kes_period", &format_args!("{:?}", self.kes_period))
+                .finish(),
+            false => debug.finish_non_exhaustive(),
+        }
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use crate::test_utils::{fake_keys, MithrilFixtureBuilder};

mithril-common/src/entities/single_signatures.rs

@@ -1,5 +1,6 @@
 use mithril_stm::stm::StmSig;
 use serde::{Deserialize, Serialize};
+use std::fmt::{Debug, Formatter};
 
 use crate::{
     crypto_helper::ProtocolSingleSignature,
@@ -8,7 +9,7 @@ use crate::{
 
 /// SingleSignatures represent single signatures originating from a participant in the network
 /// for a digest at won lottery indexes
-#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+#[derive(Clone, PartialEq, Eq, Serialize, Deserialize)]
 pub struct SingleSignatures {
     /// The unique identifier of the signer
     pub party_id: PartyId,
@@ -41,6 +42,23 @@ impl SingleSignatures {
     }
 }
 
+impl Debug for SingleSignatures {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        let is_pretty_printing = f.alternate();
+        let mut debug = f.debug_struct("SingleSignatures");
+        debug
+            .field("party_id", &self.party_id)
+            .field("won_indexes", &format_args!("{:?}", self.won_indexes));
+
+        match is_pretty_printing {
+            true => debug
+                .field("signature", &format_args!("{:?}", self.signature))
+                .finish(),
+            false => debug.finish_non_exhaustive(),
+        }
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;