Minor changes after PR review

- Enhance 'AggregatorFeaturesMessage' description in openapi
- Rename trait 'CardanoTransactionsPreloaderActivationState' to 'CardanoTransactionsPreloaderChecker'
- Modify emoji included in the 'preload' logs
- File renaming for the signer implementation of the 'CardanoTransactionsPreloaderActivationState' trait

Co-authored-by: Sébastien Fauvel <[email protected]>

Author: dlachaume

mithril-common/src/cardano_transactions_preloader.rs

@@ -15,9 +15,10 @@ use crate::signable_builder::TransactionsImporter;
 use crate::signed_entity_type_lock::SignedEntityTypeLock;
 use crate::StdResult;
 
-/// CardanoTransactionsPreloaderActivationState
+/// CardanoTransactionsPreloaderChecker gives the ability to determine
+/// if the Cardano Transactions Preloader should import the transactions.
 #[async_trait]
-pub trait CardanoTransactionsPreloaderActivationState: Send + Sync {
+pub trait CardanoTransactionsPreloaderChecker: Send + Sync {
     /// Determine if the Cardano Transactions Preloader should preload.
     async fn is_activated(&self) -> StdResult<bool>;
 }
@@ -35,7 +36,7 @@ impl CardanoTransactionsPreloaderActivation {
 }
 
 #[async_trait]
-impl CardanoTransactionsPreloaderActivationState for CardanoTransactionsPreloaderActivation {
+impl CardanoTransactionsPreloaderChecker for CardanoTransactionsPreloaderActivation {
     async fn is_activated(&self) -> StdResult<bool> {
         Ok(self.activation)
     }
@@ -49,7 +50,7 @@ pub struct CardanoTransactionsPreloader {
     security_parameter: BlockNumber,
     chain_observer: Arc<dyn ChainObserver>,
     logger: Logger,
-    activation_state: Arc<dyn CardanoTransactionsPreloaderActivationState>,
+    activation_state: Arc<dyn CardanoTransactionsPreloaderChecker>,
 }
 
 impl CardanoTransactionsPreloader {
@@ -60,7 +61,7 @@ impl CardanoTransactionsPreloader {
         security_parameter: BlockNumber,
         chain_observer: Arc<dyn ChainObserver>,
         logger: Logger,
-        activation_state: Arc<dyn CardanoTransactionsPreloaderActivationState>,
+        activation_state: Arc<dyn CardanoTransactionsPreloaderChecker>,
     ) -> Self {
         Self {
             signed_entity_type_lock,
@@ -75,26 +76,26 @@ impl CardanoTransactionsPreloader {
     /// Preload the Cardano Transactions by running the importer up to the current chain block number.
     pub async fn preload(&self) -> StdResult<()> {
         if !self.is_activated().await? {
-            info!(
+            debug!(
                 self.logger,
-                "🔥 Preload Cardano Transactions - Not running, conditions not met"
+                "⟳ Preload Cardano Transactions - Not running, conditions not met"
             );
             return Ok(());
         }
 
-        info!(self.logger, "🔥 Preload Cardano Transactions - Started");
-        debug!(self.logger, "🔥 Locking signed entity type"; "entity_type" => "CardanoTransactions");
+        info!(self.logger, "⟳ Preload Cardano Transactions - Started");
+        debug!(self.logger, "⟳ Locking signed entity type"; "entity_type" => "CardanoTransactions");
         self.signed_entity_type_lock
             .lock(SignedEntityTypeDiscriminants::CardanoTransactions)
             .await;
 
         let preload_result = self.do_preload().await;
 
-        debug!(self.logger, "🔥 Releasing signed entity type"; "entity_type" => "CardanoTransactions");
+        debug!(self.logger, "⟳ Releasing signed entity type"; "entity_type" => "CardanoTransactions");
         self.signed_entity_type_lock
             .release(SignedEntityTypeDiscriminants::CardanoTransactions)
             .await;
-        info!(self.logger, "🔥 Preload Cardano Transactions - Finished");
+        info!(self.logger, "⟳ Preload Cardano Transactions - Finished");
 
         preload_result
     }
@@ -151,9 +152,7 @@ mod tests {
     struct CardanoTransactionsPreloaderActivationWithError {}
 
     #[async_trait]
-    impl CardanoTransactionsPreloaderActivationState
-        for CardanoTransactionsPreloaderActivationWithError
-    {
+    impl CardanoTransactionsPreloaderChecker for CardanoTransactionsPreloaderActivationWithError {
         async fn is_activated(&self) -> StdResult<bool> {
             Err(anyhow::anyhow!("error"))
         }
@@ -193,8 +192,6 @@ mod tests {
 
     #[tokio::test]
     async fn do_not_call_its_inner_importer_when_is_not_activated() {
-        let security_parameter = 542;
-
         let mut chain_observer = MockChainObserver::new();
         chain_observer.expect_get_current_chain_point().never();
         let mut importer = MockTransactionsImporter::new();
@@ -203,7 +200,7 @@ mod tests {
         let preloader = CardanoTransactionsPreloader::new(
             Arc::new(SignedEntityTypeLock::default()),
             Arc::new(importer),
-            security_parameter,
+            542,
             Arc::new(chain_observer),
             TestLogger::stdout(),
             Arc::new(CardanoTransactionsPreloaderActivation::new(false)),
@@ -214,8 +211,6 @@ mod tests {
 
     #[tokio::test]
     async fn return_error_when_is_activated_return_error() {
-        let security_parameter = 542;
-
         let mut chain_observer = MockChainObserver::new();
         chain_observer.expect_get_current_chain_point().never();
         let mut importer = MockTransactionsImporter::new();
@@ -224,7 +219,7 @@ mod tests {
         let preloader = CardanoTransactionsPreloader::new(
             Arc::new(SignedEntityTypeLock::default()),
             Arc::new(importer),
-            security_parameter,
+            542,
             Arc::new(chain_observer),
             TestLogger::stdout(),
             Arc::new(CardanoTransactionsPreloaderActivationWithError {}),

mithril-common/src/messages/aggregator_features.rs

@@ -4,7 +4,7 @@ use serde::{Deserialize, Serialize};
 
 use crate::entities::SignedEntityTypeDiscriminants;
 
-/// Message sent by an Aggregator to inform about its features
+/// Message advertised by an Aggregator to inform about its features
 #[derive(Debug, Serialize, Deserialize, PartialEq)]
 pub struct AggregatorFeaturesMessage {
     /// Version of the OpenAPI specification

mithril-signer/src/cardano_transactions_preloader_activation_according_to_aggregator.rs renamed to mithril-signer/src/cardano_transactions_preloader_checker.rs

@@ -4,28 +4,26 @@ use anyhow::Context;
 use async_trait::async_trait;
 
 use mithril_common::{
-    cardano_transactions_preloader::CardanoTransactionsPreloaderActivationState,
+    cardano_transactions_preloader::CardanoTransactionsPreloaderChecker,
     entities::SignedEntityTypeDiscriminants, StdResult,
 };
 
 use crate::AggregatorClient;
 
-/// CardanoTransactionsPreloaderActivationAccordingToAggregator
-pub struct CardanoTransactionsPreloaderActivationAccordingToAggregator {
+/// CardanoTransactionsPreloaderActivationSigner
+pub struct CardanoTransactionsPreloaderActivationSigner {
     aggregator_client: Arc<dyn AggregatorClient>,
 }
 
-impl CardanoTransactionsPreloaderActivationAccordingToAggregator {
-    /// Create a new instance of `CardanoTransactionsPreloaderActivationAccordingToAggregator`
+impl CardanoTransactionsPreloaderActivationSigner {
+    /// Create a new instance of `CardanoTransactionsPreloaderActivationSigner`
     pub fn new(aggregator_client: Arc<dyn AggregatorClient>) -> Self {
         Self { aggregator_client }
     }
 }
 
 #[async_trait]
-impl CardanoTransactionsPreloaderActivationState
-    for CardanoTransactionsPreloaderActivationAccordingToAggregator
-{
+impl CardanoTransactionsPreloaderChecker for CardanoTransactionsPreloaderActivationSigner {
     async fn is_activated(&self) -> StdResult<bool> {
         let message = self
             .aggregator_client
@@ -66,9 +64,8 @@ mod tests {
                     BTreeSet::from([SignedEntityTypeDiscriminants::MithrilStakeDistribution]);
                 Ok(message)
             });
-        let preloader = CardanoTransactionsPreloaderActivationAccordingToAggregator::new(Arc::new(
-            aggregator_client,
-        ));
+        let preloader =
+            CardanoTransactionsPreloaderActivationSigner::new(Arc::new(aggregator_client));
 
         let is_activated = preloader.is_activated().await.unwrap();
 
@@ -88,9 +85,8 @@ mod tests {
                     BTreeSet::from([SignedEntityTypeDiscriminants::CardanoTransactions]);
                 Ok(message)
             });
-        let preloader = CardanoTransactionsPreloaderActivationAccordingToAggregator::new(Arc::new(
-            aggregator_client,
-        ));
+        let preloader =
+            CardanoTransactionsPreloaderActivationSigner::new(Arc::new(aggregator_client));
 
         let is_activated = preloader.is_activated().await.unwrap();
 
@@ -108,9 +104,8 @@ mod tests {
                     "Aggregator call failed"
                 )))
             });
-        let preloader = CardanoTransactionsPreloaderActivationAccordingToAggregator::new(Arc::new(
-            aggregator_client,
-        ));
+        let preloader =
+            CardanoTransactionsPreloaderActivationSigner::new(Arc::new(aggregator_client));
 
         preloader
             .is_activated()

mithril-signer/src/lib.rs

@@ -8,7 +8,7 @@
 
 mod aggregator_client;
 mod cardano_transactions_importer;
-mod cardano_transactions_preloader_activation_according_to_aggregator;
+mod cardano_transactions_preloader_checker;
 mod configuration;
 pub mod database;
 mod message_adapters;
@@ -25,7 +25,7 @@ mod upkeep_service;
 pub use aggregator_client::dumb::DumbAggregatorClient;
 pub use aggregator_client::*;
 pub use cardano_transactions_importer::*;
-pub use cardano_transactions_preloader_activation_according_to_aggregator::*;
+pub use cardano_transactions_preloader_checker::*;
 pub use configuration::{Configuration, DefaultConfiguration};
 pub use message_adapters::{
     FromEpochSettingsAdapter, FromPendingCertificateMessageAdapter, ToRegisterSignerMessageAdapter,

mithril-signer/src/runtime/signer_services.rs

@@ -33,8 +33,8 @@ use mithril_persistence::{
 use crate::{
     aggregator_client::AggregatorClient, metrics::MetricsService, single_signer::SingleSigner,
     AggregatorHTTPClient, CardanoTransactionsImporter,
-    CardanoTransactionsPreloaderActivationAccordingToAggregator, Configuration,
-    MithrilSingleSigner, ProtocolInitializerStore, ProtocolInitializerStorer, SignerUpkeepService,
+    CardanoTransactionsPreloaderActivationSigner, Configuration, MithrilSingleSigner,
+    ProtocolInitializerStore, ProtocolInitializerStorer, SignerUpkeepService,
     TransactionsImporterByChunk, TransactionsImporterWithPruner, TransactionsImporterWithVacuum,
     UpkeepService, HTTP_REQUEST_TIMEOUT_DURATION, SQLITE_FILE, SQLITE_FILE_CARDANO_TRANSACTION,
 };
@@ -254,7 +254,7 @@ impl<'a> ServiceBuilder for ProductionServiceBuilder<'a> {
         ));
 
         let api_version_provider = Arc::new(APIVersionProvider::new(era_checker.clone()));
-        let certificate_handler = Arc::new(AggregatorHTTPClient::new(
+        let aggregator_client = Arc::new(AggregatorHTTPClient::new(
             self.config.aggregator_endpoint.clone(),
             self.config.relay_endpoint.clone(),
             api_version_provider.clone(),
@@ -327,9 +327,8 @@ impl<'a> ServiceBuilder for ProductionServiceBuilder<'a> {
             cardano_transactions_builder,
         ));
         let metrics_service = Arc::new(MetricsService::new().unwrap());
-        let preloader_activation = CardanoTransactionsPreloaderActivationAccordingToAggregator::new(
-            certificate_handler.clone(),
-        );
+        let preloader_activation =
+            CardanoTransactionsPreloaderActivationSigner::new(aggregator_client.clone());
         let cardano_transactions_preloader = Arc::new(CardanoTransactionsPreloader::new(
             signed_entity_type_lock.clone(),
             preloader_transactions_importer,
@@ -347,7 +346,7 @@ impl<'a> ServiceBuilder for ProductionServiceBuilder<'a> {
 
         let services = SignerServices {
             ticker_service,
-            certificate_handler,
+            certificate_handler: aggregator_client,
             chain_observer,
             digester,
             single_signer,

openapi.yaml

@@ -532,7 +532,7 @@ paths:
 components:
   schemas:
     AggregatorFeaturesMessage:
-      description: Aggregator public information
+      description: Represents general information about Mithril project, Aggregator public information and signing capabilities
       type: object
       additionalProperties: false
       required: