Merge pull request #891 from input-output-hk/ensemble/852/immutable_signable_signer

add signable builder in signer

Author: ghubertpalo

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-aggregator"
-version = "0.3.9"
+version = "0.3.10"
 description = "A Mithril Aggregator server"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-aggregator/Cargo.toml

@@ -16,6 +16,7 @@ use mithril_common::{
         adapters::{EraReaderAdapterBuilder, EraReaderDummyAdapter},
         EraChecker, EraMarker, EraReader, EraReaderAdapter, SupportedEra,
     },
+    signable_builder::CardanoImmutableFilesFullSignableBuilder,
     store::adapter::{MemoryAdapter, SQLiteAdapter, StoreAdapter},
     BeaconProvider, BeaconProviderImpl,
 };
@@ -42,9 +43,7 @@ use crate::{
     },
     event_store::{EventMessage, EventStore, TransmitterService},
     http_server::routes::router,
-    signable_builder::{
-        ImmutableSignableBuilder, MithrilStakeDistributionSignableBuilder, SignableBuilderService,
-    },
+    signable_builder::{MithrilStakeDistributionSignableBuilder, SignableBuilderService},
     signer_registerer::SignerRecorder,
     stake_distribution_service::{MithrilStakeDistributionService, StakeDistributionService},
     ticker_service::{MithrilTickerService, TickerService},
@@ -877,8 +876,10 @@ impl DependenciesBuilder {
         let multi_signer = self.get_multi_signer().await?;
         let mithril_stake_distribution_builder =
             MithrilStakeDistributionSignableBuilder::new(multi_signer);
-        let immutable_signable_builder =
-            ImmutableSignableBuilder::new(self.get_immutable_digester().await?);
+        let immutable_signable_builder = CardanoImmutableFilesFullSignableBuilder::new(
+            self.get_immutable_digester().await?,
+            self.get_logger().await?,
+        );
         let signable_builder_service = Arc::new(SignableBuilderService::new(
             mithril_stake_distribution_builder,
             immutable_signable_builder,

mithril-aggregator/src/dependency_injection/builder.rs

@@ -40,7 +40,7 @@ pub use crate::configuration::{
 };
 pub use crate::multi_signer::{MultiSigner, MultiSignerImpl, ProtocolError};
 pub use crate::signable_builder::{
-    ImmutableSignableBuilder, MithrilStakeDistributionSignableBuilder, SignableBuilderService,
+    MithrilStakeDistributionSignableBuilder, SignableBuilderService,
 };
 pub use crate::snapshot_stores::{LocalSnapshotStore, SnapshotStore};
 pub use command_args::MainOpts;

mithril-aggregator/src/lib.rs

@@ -1,9 +1,7 @@
 //! The module used for building signables
 
-mod immutable_signable_builder;
 mod mithril_stake_distribution;
 mod signable_builder_service;
 
-pub use immutable_signable_builder::*;
 pub use mithril_stake_distribution::*;
 pub use signable_builder_service::*;

mithril-aggregator/src/signable_builder/mod.rs

@@ -2,23 +2,23 @@ use std::sync::Arc;
 
 use mithril_common::{
     entities::SignedEntityType,
-    signable_builder::{Signable, SignableBuilder},
+    signable_builder::{CardanoImmutableFilesFullSignableBuilder, Signable, SignableBuilder},
     StdResult,
 };
 
-use super::{ImmutableSignableBuilder, MithrilStakeDistributionSignableBuilder};
+use super::MithrilStakeDistributionSignableBuilder;
 
 /// SignableBuilder Service
 pub struct SignableBuilderService {
     mithril_stake_distribution_builder: MithrilStakeDistributionSignableBuilder,
-    immutable_signable_builder: ImmutableSignableBuilder,
+    immutable_signable_builder: CardanoImmutableFilesFullSignableBuilder,
 }
 
 impl SignableBuilderService {
     /// SignableBuilderService factory
     pub fn new(
         mithril_stake_distribution_builder: MithrilStakeDistributionSignableBuilder,
-        immutable_signable_builder: ImmutableSignableBuilder,
+        immutable_signable_builder: CardanoImmutableFilesFullSignableBuilder,
     ) -> Self {
         Self {
             mithril_stake_distribution_builder,

mithril-aggregator/src/signable_builder/signable_builder_service.rs

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

mithril-common/Cargo.toml

@@ -261,7 +261,7 @@ mod tests {
 
     #[tokio::test]
     async fn reset_clear_existing_values() {
-        let file = get_test_dir("store_erase_existing_values").join("immutable-cache-store.json");
+        let file = get_test_dir("reset_clear_existing_values").join("immutable-cache-store.json");
         let provider = JsonImmutableFileDigestCacheProvider::new(&file);
         let values_to_store = vec![
             ("0.chunk".to_string(), "digest 0".to_string()),

mithril-common/src/digesters/cache/json_provider.rs

@@ -1,29 +1,36 @@
 use std::sync::Arc;
 
-use async_trait::async_trait;
-use mithril_common::{
+use crate::{
     digesters::ImmutableDigester,
     entities::{Beacon, ProtocolMessage, ProtocolMessagePartKey},
     signable_builder::SignableBuilder,
     StdResult,
 };
+use async_trait::async_trait;
+use slog::{debug, info, Logger};
 
-/// A [SignableBuilder] for cardano immutable files.
-pub struct ImmutableSignableBuilder {
+/// This structure is responsible of calculating the message for Cardano immutable files snapshots.
+pub struct CardanoImmutableFilesFullSignableBuilder {
     immutable_digester: Arc<dyn ImmutableDigester>,
+    logger: Logger,
 }
 
-impl ImmutableSignableBuilder {
+impl CardanoImmutableFilesFullSignableBuilder {
     /// Constructor
-    pub fn new(immutable_digester: Arc<dyn ImmutableDigester>) -> Self {
-        Self { immutable_digester }
+    pub fn new(immutable_digester: Arc<dyn ImmutableDigester>, logger: Logger) -> Self {
+        Self {
+            immutable_digester,
+            logger,
+        }
     }
 }
 
 #[async_trait]
-impl SignableBuilder<Beacon, ProtocolMessage> for ImmutableSignableBuilder {
+impl SignableBuilder<Beacon, ProtocolMessage> for CardanoImmutableFilesFullSignableBuilder {
     async fn compute_signable(&self, beacon: Beacon) -> StdResult<ProtocolMessage> {
+        debug!(self.logger, "SignableBuilder::compute_signable({beacon:?})");
         let digest = self.immutable_digester.compute_digest(&beacon).await?;
+        info!(self.logger, "SignableBuilder: digest = '{digest}'.");
         let mut protocol_message = ProtocolMessage::new();
         protocol_message.set_message_part(ProtocolMessagePartKey::SnapshotDigest, digest);
 
@@ -35,9 +42,10 @@ impl SignableBuilder<Beacon, ProtocolMessage> for ImmutableSignableBuilder {
 mod tests {
     use super::*;
 
+    use crate::digesters::{ImmutableDigester, ImmutableDigesterError};
+    use crate::entities::Beacon;
     use async_trait::async_trait;
-    use mithril_common::digesters::{ImmutableDigester, ImmutableDigesterError};
-    use mithril_common::entities::Beacon;
+    use slog::Drain;
 
     #[derive(Default)]
     pub struct ImmutableDigesterImpl;
@@ -48,10 +56,18 @@ mod tests {
             Ok(format!("immutable {}", beacon.immutable_file_number))
         }
     }
+
+    fn create_logger() -> slog::Logger {
+        let decorator = slog_term::PlainDecorator::new(slog_term::TestStdoutWriter);
+        let drain = slog_term::CompactFormat::new(decorator).build().fuse();
+        let drain = slog_async::Async::new(drain).build().fuse();
+        slog::Logger::root(Arc::new(drain), slog::o!())
+    }
     #[tokio::test]
     async fn compute_signable() {
         let digester = ImmutableDigesterImpl::default();
-        let signable_builder = ImmutableSignableBuilder::new(Arc::new(digester));
+        let signable_builder =
+            CardanoImmutableFilesFullSignableBuilder::new(Arc::new(digester), create_logger());
         let protocol_message = signable_builder
             .compute_signable(Beacon::default())
             .await

mithril-aggregator/src/signable_builder/immutable_signable_builder.rs renamed to mithril-common/src/signable_builder/cardano_immutable_full_signable_builder.rs

@@ -1,7 +1,9 @@
 //! The module used for building signables
 
+mod cardano_immutable_full_signable_builder;
 mod dummy_signable;
 mod interface;
 
+pub use cardano_immutable_full_signable_builder::*;
 pub use dummy_signable::*;
 pub use interface::*;