PR Review feedback

input-output-hk · Mar 28, 2024 · a87ff74 · a87ff74
1 parent 924ba55
commit a87ff74
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 3 deletions.
diff --git a/mithril-common/src/entities/certificate.rs b/mithril-common/src/entities/certificate.rs
@@ -17,7 +17,7 @@ pub enum CertificateSignature {
     GenesisSignature(ProtocolGenesisSignature),
 
     /// STM multi signature created from a quorum of single signatures from the signers
-    /// aka MULTI_SIG(H(MSG(p,n) || AVK(n-1)))
+    /// aka (BEACON(p,n), MULTI_SIG(H(MSG(p,n) || AVK(n-1))))
     MultiSignature(SignedEntityType, ProtocolMultiSignature),
 }
 

diff --git a/mithril-common/src/messages/certificate.rs b/mithril-common/src/messages/certificate.rs
@@ -32,10 +32,10 @@ pub struct CertificateMessage {
     pub epoch: Epoch,
 
     /// The signed entity type of the message.
+    /// aka BEACON(p,n)
     pub signed_entity_type: SignedEntityType,
 
     /// Mithril beacon on the Cardano chain
-    /// aka BEACON(p,n)
     #[deprecated(since = "0.3.21", note = "use epoch and/or signed_entity_type instead")]
     pub beacon: CardanoDbBeacon,
 

diff --git a/mithril-common/src/messages/certificate_list.rs b/mithril-common/src/messages/certificate_list.rs
@@ -14,6 +14,7 @@ pub type CertificateListMessage = Vec<CertificateListItemMessage>;
 #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
 pub struct CertificateListItemMessageMetadata {
     /// Cardano network
+    /// part of METADATA(p,n)
     pub network: String,
 
     /// Protocol Version (semver)
@@ -60,10 +61,10 @@ pub struct CertificateListItemMessage {
     pub epoch: Epoch,
 
     /// The signed entity type of the message.
+    /// aka BEACON(p,n)
     pub signed_entity_type: SignedEntityType,
 
     /// Mithril beacon on the Cardano chain
-    /// aka BEACON(p,n)
     #[deprecated(since = "0.3.21", note = "use epoch and/or signed_entity_type instead")]
     pub beacon: CardanoDbBeacon,
 

diff --git a/mithril-common/src/messages/message_parts/certificate_metadata.rs b/mithril-common/src/messages/message_parts/certificate_metadata.rs
@@ -7,6 +7,7 @@ use serde::{Deserialize, Serialize};
 #[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
 pub struct CertificateMetadataMessagePart {
     /// Cardano network
+    /// part of METADATA(p,n)
     pub network: String,
 
     /// Protocol Version (semver)