Merge pull request #822 from input-output-hk/jpraynaud/820-enhance-error-key-registration

Enhance Key Registration errors

Author: jpraynaud

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-common"
-version = "0.2.29"
+version = "0.2.30"
 authors = { workspace = true }
 edition = { workspace = true }
 documentation = { workspace = true }

mithril-common/Cargo.toml

@@ -1,5 +1,6 @@
 use crate::crypto_helper::cardano::{
-    KeyRegWrapper, ProtocolRegistrationErrorWrapper, StmInitializerWrapper,
+    KeyRegWrapper, ProtocolInitializerErrorWrapper, ProtocolRegistrationErrorWrapper,
+    StmInitializerWrapper,
 };
 
 use mithril_stm::stm::{
@@ -70,8 +71,11 @@ pub type ProtocolGenesisSecretKey = ed25519_dalek::SecretKey;
 pub type ProtocolGenesisSignature = ed25519_dalek::Signature;
 
 // Error alias
-/// Alias of a wrapper of [MithrilStm:RegisterError](enum@mithril_stm::RegisterError).
+/// Alias of a wrapper of [MithrilCommon:ProtocolRegistrationErrorWrapper](enum@mithril_common::ProtocolRegistrationErrorWrapper).
 pub type ProtocolRegistrationError = ProtocolRegistrationErrorWrapper;
 
+/// Alias of a wrapper of [MithrilCommon:ProtocolInitializerErrorWrapper](enum@mithril_common::ProtocolInitializerErrorWrapper).
+pub type ProtocolInitializerError = ProtocolInitializerErrorWrapper;
+
 /// Alias of [MithrilStm:AggregationError](enum@mithril_stm::AggregationError).
 pub type ProtocolAggregationError = AggregationError;

mithril-common/src/crypto_helper/types.rs

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-signer"
-version = "0.2.25"
+version = "0.2.26"
 description = "A Mithril Signer"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-signer/Cargo.toml

@@ -1,7 +1,10 @@
 use slog_scope::{crit, debug, error, info};
 use std::{fmt::Display, thread::sleep, time::Duration};
 
-use mithril_common::entities::{Beacon, CertificatePending, Epoch, EpochSettings, SignerWithStake};
+use mithril_common::{
+    crypto_helper::ProtocolInitializerError,
+    entities::{Beacon, CertificatePending, Epoch, EpochSettings, SignerWithStake},
+};
 
 use super::{Runner, RuntimeError};
 
@@ -304,15 +307,18 @@ impl StateMachine {
             .map_err(|e| RuntimeError::KeepState {
                 message: format!("Could not update stake distribution in 'unregistered → registered' phase for epoch {:?}.", beacon.epoch),
                 nested_error: Some(e) })?;
-        self.runner
-            .register_signer_to_aggregator(
-                epoch_settings.epoch,
-                &epoch_settings.next_protocol_parameters,
-            )
-            .await
-            .map_err(|e| RuntimeError::KeepState {
-                message: format!("Could not register to aggregator in 'unregistered → registered' phase for epoch {:?}.", beacon.epoch),
-                nested_error: Some(e) })?;
+
+        self.runner. register_signer_to_aggregator(
+            epoch_settings.epoch,
+            &epoch_settings.next_protocol_parameters,
+        )
+        .await.map_err(|e| {
+            if e.downcast_ref::<ProtocolInitializerError>().is_some(){
+                RuntimeError::Critical { message: format!("Could not register to aggregator in 'unregistered → registered' phase for epoch {:?}.", beacon.epoch), nested_error: Some(e) }
+            }else{
+                RuntimeError::KeepState { message: format!("Could not register to aggregator in 'unregistered → registered' phase for epoch {:?}.", beacon.epoch), nested_error: Some(e) }
+            }
+        })?;
 
         Ok(SignerState::Registered { beacon })
     }

mithril-signer/src/runtime/state_machine.rs

@@ -5,8 +5,8 @@ use thiserror::Error;
 
 use mithril_common::crypto_helper::{
     key_decode_hex, key_encode_hex, KESPeriod, ProtocolClerk, ProtocolInitializer,
-    ProtocolKeyRegistration, ProtocolPartyId, ProtocolRegistrationError, ProtocolSigner,
-    ProtocolStakeDistribution,
+    ProtocolInitializerError, ProtocolKeyRegistration, ProtocolPartyId, ProtocolRegistrationError,
+    ProtocolSigner, ProtocolStakeDistribution,
 };
 use mithril_common::entities::{
     PartyId, ProtocolMessage, ProtocolParameters, SignerWithStake, SingleSignatures, Stake,
@@ -15,14 +15,6 @@ use mithril_common::entities::{
 #[cfg(test)]
 use mockall::automock;
 
-/// MithrilProtocolInitializerBuilder error structure.
-#[derive(Error, Debug)]
-pub enum MithrilProtocolInitializerBuilderError {
-    /// Could not parse a Cardano crypto file
-    #[error("the cardano cryptographic file could not be parsed.")]
-    CardanoCryptoParse,
-}
-
 /// This is responsible of creating new instances of ProtocolInitializer.
 #[derive(Default)]
 pub struct MithrilProtocolInitializerBuilder {}
@@ -40,16 +32,15 @@ impl MithrilProtocolInitializerBuilder {
         protocol_parameters: &ProtocolParameters,
         kes_secret_key_path: Option<PathBuf>,
         kes_period: Option<KESPeriod>,
-    ) -> Result<ProtocolInitializer, MithrilProtocolInitializerBuilderError> {
+    ) -> Result<ProtocolInitializer, ProtocolInitializerError> {
         let mut rng = rand_core::OsRng;
         let protocol_initializer = ProtocolInitializer::setup(
             protocol_parameters.to_owned().into(),
             kes_secret_key_path,
             kes_period,
             stake.to_owned(),
             &mut rng,
-        )
-        .map_err(|_| MithrilProtocolInitializerBuilderError::CardanoCryptoParse)?;
+        )?;
 
         Ok(protocol_initializer)
     }