fix: TODO 'Should be removed once the signer certification is fully

deployed' - 'mithril-common/src/crypto_helper/cardano/key_certification.rs' - 'mithril-common/src/entities/signer.rs' - 'mithril-common/src/messages/message_parts/signer.rs' - 'mithril-common/src/messages/register_signer.rs' - 'mithril-signer/src/configuration.rs' - 'mithril-test-lab/mithril-devnet/mkfiles/mkfiles-docker.sh' - 'mithril-test-lab/mithril-end-to-end/src/mithril/infrastructure.rs'
input-output-hk · Jan 9, 2025 · 55b2e82 · 55b2e82
1 parent 423e225
commit 55b2e82
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 28 deletions.
diff --git a/mithril-common/src/crypto_helper/cardano/key_certification.rs b/mithril-common/src/crypto_helper/cardano/key_certification.rs
@@ -43,7 +43,8 @@ pub type KESPeriod = u32;
 #[derive(Error, Debug)]
 pub enum ProtocolRegistrationErrorWrapper {
     /// Error raised when a party id is needed but not provided
-    // TODO: Should be removed once the signer certification is fully deployed
+    ///
+    /// Used only for testing when SPO pool id is not certified
     #[error("missing party id")]
     PartyIdMissing,
 
@@ -246,9 +247,9 @@ impl KeyRegWrapper {
     /// Mithril key (with its corresponding Proof of Possession).
     pub fn register(
         &mut self,
-        party_id: Option<ProtocolPartyId>, // TODO: Parameter should be removed once the signer certification is fully deployed
-        opcert: Option<ProtocolOpCert>, // TODO: Option should be removed once the signer certification is fully deployed
-        kes_sig: Option<ProtocolSignerVerificationKeySignature>, // TODO: Option should be removed once the signer certification is fully deployed
+        party_id: Option<ProtocolPartyId>, // Used for only for testing when SPO pool id is not certified
+        opcert: Option<ProtocolOpCert>, // Used for only for testing when SPO pool id is not certified
+        kes_sig: Option<ProtocolSignerVerificationKeySignature>, // Used for only for testing when SPO pool id is not certified
         kes_period: Option<KESPeriod>,
         pk: ProtocolSignerVerificationKey,
     ) -> Result<ProtocolPartyId, ProtocolRegistrationErrorWrapper> {

diff --git a/mithril-common/src/entities/signer.rs b/mithril-common/src/entities/signer.rs
@@ -14,19 +14,22 @@ use sha2::{Digest, Sha256};
 #[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
+    ///
+    /// Used only for testing when SPO pool id is not certified
     pub party_id: PartyId,
 
     /// The public key used to authenticate signer signature
     pub verification_key: ProtocolSignerVerificationKey,
 
     /// The encoded signer 'Mithril verification key' signature (signed by the Cardano node KES secret key)
-    // TODO: Option should be removed once the signer certification is fully deployed
+    ///
+    /// None is used only for testing when SPO pool id is not certified
     #[serde(skip_serializing_if = "Option::is_none")]
     pub verification_key_signature: Option<ProtocolSignerVerificationKeySignature>,
 
     /// The encoded operational certificate of stake pool operator attached to the signer node
-    // TODO: Option should be removed once the signer certification is fully deployed
+    ///
+    /// None is used only for testing when SPO pool id is not certified
     #[serde(skip_serializing_if = "Option::is_none")]
     pub operational_certificate: Option<ProtocolOpCert>,
 
@@ -136,19 +139,22 @@ impl From<SignerWithStake> for Signer {
 #[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
+    ///
+    /// Used only for testing when SPO pool id is not certified
     pub party_id: PartyId,
 
     /// The public key used to authenticate signer signature
     pub verification_key: ProtocolSignerVerificationKey,
 
     /// The encoded signer 'Mithril verification key' signature (signed by the Cardano node KES secret key)
-    // TODO: Option should be removed once the signer certification is fully deployed
+    ///
+    /// None is used only for testing when SPO pool id is not certified
     #[serde(skip_serializing_if = "Option::is_none")]
     pub verification_key_signature: Option<ProtocolSignerVerificationKeySignature>,
 
     /// The encoded operational certificate of stake pool operator attached to the signer node
-    // TODO: Option should be removed once the signer certification is fully deployed
+    ///
+    /// None is used only for testing when SPO pool id is not certified
     #[serde(skip_serializing_if = "Option::is_none")]
     pub operational_certificate: Option<ProtocolOpCert>,
 

diff --git a/mithril-common/src/messages/message_parts/signer.rs b/mithril-common/src/messages/message_parts/signer.rs
@@ -16,23 +16,24 @@ use std::fmt::{Debug, Formatter};
 #[derive(Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
 pub struct SignerWithStakeMessagePart {
     /// The unique identifier of the signer
-    // TODO: Should be removed once the signer certification is fully deployed
+    ///
+    /// Used only for testing when SPO pool id is not certified
     pub party_id: PartyId,
 
     /// The public key used to authenticate signer signature
     pub verification_key: HexEncodedVerificationKey,
 
     /// The encoded signer 'Mithril verification key' signature (signed by the
     /// Cardano node KES secret key).
-    // TODO: Option should be removed once the signer certification is fully
-    //       deployed.
+    ///
+    /// None is used only for testing when SPO pool id is not certified
     #[serde(skip_serializing_if = "Option::is_none")]
     pub verification_key_signature: Option<HexEncodedVerificationKeySignature>,
 
     /// The encoded operational certificate of stake pool operator attached to
     /// the signer node.
-    // TODO: Option should be removed once the signer certification is fully
-    //       deployed.
+    ///
+    /// None is used only for testing when SPO pool id is not certified
     #[serde(skip_serializing_if = "Option::is_none")]
     pub operational_certificate: Option<HexEncodedOpCert>,
 
@@ -161,23 +162,24 @@ impl Debug for SignerMessagePart {
 #[derive(Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
 pub struct SignerMessagePart {
     /// The unique identifier of the signer
-    // TODO: Should be removed once the signer certification is fully deployed
+    ///
+    /// Used only for testing when SPO pool id is not certified
     pub party_id: PartyId,
 
     /// The public key used to authenticate signer signature
     pub verification_key: HexEncodedVerificationKey,
 
     /// The encoded signer 'Mithril verification key' signature (signed by the
     /// Cardano node KES secret key).
-    // TODO: Option should be removed once the signer certification is fully
-    //       deployed.
+    ///
+    /// None is used only for testing when SPO pool id is not certified
     #[serde(skip_serializing_if = "Option::is_none")]
     pub verification_key_signature: Option<HexEncodedVerificationKeySignature>,
 
     /// The encoded operational certificate of stake pool operator attached to
     /// the signer node.
-    // TODO: Option should be removed once the signer certification is fully
-    //       deployed.
+    ///
+    /// None is used only for testing when SPO pool id is not certified
     #[serde(skip_serializing_if = "Option::is_none")]
     pub operational_certificate: Option<HexEncodedOpCert>,
 

diff --git a/mithril-common/src/messages/register_signer.rs b/mithril-common/src/messages/register_signer.rs
@@ -13,23 +13,24 @@ pub struct RegisterSignerMessage {
     pub epoch: Epoch,
 
     /// The unique identifier of the signer
-    // TODO: Should be removed once the signer certification is fully deployed
+    ///
+    /// Used only for testing when SPO pool id is not certified
     pub party_id: PartyId,
 
     /// The public key used to authenticate signer signature
     pub verification_key: HexEncodedVerificationKey,
 
     /// The encoded signer 'Mithril verification key' signature (signed by the
     /// Cardano node KES secret key).
-    // TODO: Option should be removed once the signer certification is fully
-    //       deployed.
+    ///
+    /// None is used only for testing when SPO pool id is not certified
     #[serde(skip_serializing_if = "Option::is_none")]
     pub verification_key_signature: Option<HexEncodedVerificationKeySignature>,
 
     /// The encoded operational certificate of stake pool operator attached to
     /// the signer node.
-    // TODO: Option should be removed once the signer certification is fully
-    //       deployed.
+    ///
+    /// None is used only for testing when SPO pool id is not certified
     #[serde(skip_serializing_if = "Option::is_none")]
     pub operational_certificate: Option<HexEncodedOpCert>,
 

diff --git a/mithril-signer/src/configuration.rs b/mithril-signer/src/configuration.rs
@@ -52,7 +52,8 @@ pub struct Configuration {
     pub relay_endpoint: Option<String>,
 
     /// Party Id
-    // TODO: Field should be removed once the signer certification is fully deployed
+    ///
+    /// Used only for testing when SPO pool id is not certified
     #[example = "`pool1pxaqe80sqpde7902er5kf6v0c7y0sv6d5g676766v2h829fvs3x`"]
     pub party_id: Option<PartyId>,
 

diff --git a/mithril-test-lab/mithril-devnet/mkfiles/mkfiles-docker.sh b/mithril-test-lab/mithril-devnet/mkfiles/mkfiles-docker.sh
@@ -229,7 +229,6 @@ EOF
 EOF
 else
     # 50% of signers without key certification (legacy)
-    # TODO: Should be removed once the signer certification is fully deployed
     cat >> ${NODE}/info.json <<EOF
 {
 "name": "Signer ${NODE_ID}",

diff --git a/mithril-test-lab/mithril-end-to-end/src/mithril/infrastructure.rs b/mithril-test-lab/mithril-end-to-end/src/mithril/infrastructure.rs
@@ -259,7 +259,6 @@ impl MithrilInfrastructure {
         for (index, pool_node) in pool_nodes.iter().enumerate() {
             // 50% of signers with key certification if allow unverified signer registration
             // Or 100% of signers otherwise
-            // TODO: Should be removed once the signer certification is fully deployed
             let enable_certification =
                 index % 2 == 0 || cfg!(not(feature = "allow_skip_signer_certification"));
             let aggregator_endpoint = if config.use_p2p_network_mode {