Merge pull request #903 from input-output-hk/ensemble/854-use-signable-builder-service-signer

jpraynaud · web-flow · commit c5ca3213c52d · 2023-05-09T09:58:40.000+02:00
Use Signable Builder Service in signer
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/mithril-aggregator/Cargo.toml b/mithril-aggregator/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mithril-aggregator"
-version = "0.3.13"
+version = "0.3.14"
 description = "A Mithril Aggregator server"
 authors = { workspace = true }
 edition = { workspace = true }
diff --git a/mithril-aggregator/src/dependency.rs b/mithril-aggregator/src/dependency.rs
@@ -6,6 +6,7 @@ use mithril_common::{
     digesters::{ImmutableDigester, ImmutableFileObserver},
     entities::{Certificate, Epoch, ProtocolParameters, SignerWithStake, StakeDistribution},
     era::{EraChecker, EraReader},
+    signable_builder::SignableBuilderService,
     store::StakeStorer,
     test_utils::MithrilFixture,
     BeaconProvider,
@@ -17,9 +18,9 @@ use tokio::sync::{Mutex, RwLock};
 
 use crate::{
     artifact_builder::ArtifactBuilderService, certifier_service::CertifierService,
-    configuration::*, database::provider::StakePoolStore, signable_builder::SignableBuilderService,
-    signer_registerer::SignerRecorder, ticker_service::TickerService, CertificatePendingStore,
-    CertificateStore, ProtocolParametersStore, ProtocolParametersStorer, SignerRegisterer,
+    configuration::*, database::provider::StakePoolStore, signer_registerer::SignerRecorder,
+    ticker_service::TickerService, CertificatePendingStore, CertificateStore,
+    ProtocolParametersStore, ProtocolParametersStorer, SignerRegisterer,
     SignerRegistrationRoundOpener, Snapshotter, VerificationKeyStore, VerificationKeyStorer,
 };
 use crate::{event_store::EventMessage, snapshot_stores::SnapshotStore};
diff --git a/mithril-aggregator/src/dependency_injection/builder.rs b/mithril-aggregator/src/dependency_injection/builder.rs
@@ -19,6 +19,7 @@ use mithril_common::{
     signable_builder::{
         CardanoImmutableFilesFullSignableBuilder, MithrilStakeDistributionSignableBuilder,
     },
+    signable_builder::{MithrilSignableBuilderService, SignableBuilderService},
     store::adapter::{MemoryAdapter, SQLiteAdapter, StoreAdapter},
     BeaconProvider, BeaconProviderImpl,
 };
@@ -48,7 +49,6 @@ use crate::{
     },
     event_store::{EventMessage, EventStore, TransmitterService},
     http_server::routes::router,
-    signable_builder::{MithrilSignableBuilderService, SignableBuilderService},
     signer_registerer::SignerRecorder,
     stake_distribution_service::{MithrilStakeDistributionService, StakeDistributionService},
     ticker_service::{MithrilTickerService, TickerService},
diff --git a/mithril-aggregator/src/lib.rs b/mithril-aggregator/src/lib.rs
@@ -24,7 +24,6 @@ mod http_server;
 mod message_adapters;
 mod multi_signer;
 mod runtime;
-mod signable_builder;
 mod signer_registerer;
 mod snapshot_stores;
 mod snapshot_uploaders;
@@ -39,7 +38,6 @@ pub use crate::configuration::{
     Configuration, DefaultConfiguration, ExecutionEnvironment, SnapshotUploaderType,
 };
 pub use crate::multi_signer::{MultiSigner, MultiSignerImpl, ProtocolError};
-pub use crate::signable_builder::SignableBuilderService;
 pub use crate::snapshot_stores::{LocalSnapshotStore, SnapshotStore};
 pub use command_args::MainOpts;
 pub use dependency::DependencyManager;
diff --git a/mithril-aggregator/src/signable_builder/mod.rs b/mithril-aggregator/src/signable_builder/mod.rs
diff --git a/mithril-common/Cargo.toml b/mithril-common/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mithril-common"
-version = "0.2.49"
+version = "0.2.50"
 authors = { workspace = true }
 edition = { workspace = true }
 documentation = { workspace = true }
diff --git a/mithril-common/src/signable_builder/mod.rs b/mithril-common/src/signable_builder/mod.rs
@@ -3,7 +3,9 @@
 mod cardano_immutable_full_signable_builder;
 mod interface;
 mod mithril_stake_distribution;
+mod signable_builder_service;
 
 pub use cardano_immutable_full_signable_builder::*;
 pub use interface::*;
 pub use mithril_stake_distribution::*;
+pub use signable_builder_service::*;
diff --git a/mithril-common/src/signable_builder/signable_builder_service.rs b/mithril-common/src/signable_builder/signable_builder_service.rs
@@ -1,7 +1,7 @@
 use async_trait::async_trait;
 use std::sync::Arc;
 
-use mithril_common::{
+use crate::{
     entities::{Beacon, Epoch, ProtocolMessage, SignedEntityType},
     signable_builder::SignableBuilder,
     StdResult,
@@ -68,7 +68,7 @@ impl SignableBuilderService for MithrilSignableBuilderService {
 mod tests {
     use super::*;
 
-    use mithril_common::{
+    use crate::{
         entities::{Epoch, ProtocolMessage},
         signable_builder::{Beacon as Beaconnable, SignableBuilder},
         StdResult,
diff --git a/mithril-signer/Cargo.toml b/mithril-signer/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mithril-signer"
-version = "0.2.39"
+version = "0.2.40"
 description = "A Mithril Signer"
 authors = { workspace = true }
 edition = { workspace = true }
diff --git a/mithril-signer/src/lib.rs b/mithril-signer/src/lib.rs
@@ -11,7 +11,6 @@ mod configuration;
 mod message_adapters;
 mod protocol_initializer_store;
 mod runtime;
-mod signable_builder;
 mod single_signer;
 
 #[cfg(test)]
@@ -23,5 +22,4 @@ pub use message_adapters::{
 };
 pub use protocol_initializer_store::{ProtocolInitializerStore, ProtocolInitializerStorer};
 pub use runtime::*;
-pub use signable_builder::*;
 pub use single_signer::*;
diff --git a/mithril-signer/src/runtime/runner.rs b/mithril-signer/src/runtime/runner.rs
@@ -9,7 +9,7 @@ use mockall::automock;
 use mithril_common::crypto_helper::{
     key_decode_hex, KESPeriod, OpCert, ProtocolSignerVerificationKey, SerDeShelleyFileFormat,
 };
-use mithril_common::entities::{PartyId, ProtocolParameters};
+use mithril_common::entities::{PartyId, ProtocolParameters, SignedEntityType};
 use mithril_common::{
     crypto_helper::key_encode_hex,
     entities::{
@@ -69,7 +69,7 @@ pub trait Runner {
     /// Create the message to be signed with the single signature.
     async fn compute_message(
         &self,
-        beacon: &Beacon,
+        signed_entity_type: &SignedEntityType,
         next_signers: &[SignerWithStake],
     ) -> Result<ProtocolMessage, Box<dyn StdError + Sync + Send>>;
 
@@ -352,19 +352,25 @@ impl Runner for SignerRunner {
 
     async fn compute_message(
         &self,
-        beacon: &Beacon,
+        signed_entity_type: &SignedEntityType,
         next_signers: &[SignerWithStake],
     ) -> Result<ProtocolMessage, Box<dyn StdError + Sync + Send>> {
         debug!("RUNNER: compute_message");
 
-        let mut message = ProtocolMessage::new();
-        // 1 set the digest in the message
-        let digest = self.services.digester.compute_digest(beacon).await?;
-        info!(" > set message digest: {}", digest);
-        message.set_message_part(ProtocolMessagePartKey::SnapshotDigest, digest);
+        // 1 compute the signed entity type part of the message
+        let mut message = self
+            .services
+            .signable_builder_service
+            .compute_protocol_message(signed_entity_type.to_owned())
+            .await?;
 
         // 2 set the next signers keys and stakes in the message
-        let next_signer_retrieval_epoch = beacon.epoch.offset_to_next_signer_retrieval_epoch();
+        let epoch = match signed_entity_type {
+            SignedEntityType::MithrilStakeDistribution(epoch) => epoch,
+            SignedEntityType::CardanoImmutableFilesFull(beacon) => &beacon.epoch,
+            SignedEntityType::CardanoStakeDistribution(epoch) => epoch,
+        };
+        let next_signer_retrieval_epoch = epoch.offset_to_next_signer_retrieval_epoch();
         let next_protocol_initializer = self
             .services
             .protocol_initializer_store
@@ -486,7 +492,8 @@ mod tests {
             EraChecker, EraReader,
         },
         signable_builder::{
-            CardanoImmutableFilesFullSignableBuilder, MithrilStakeDistributionSignableBuilder,
+            CardanoImmutableFilesFullSignableBuilder, MithrilSignableBuilderService,
+            MithrilStakeDistributionSignableBuilder,
         },
         store::{
             adapter::{DumbStoreAdapter, MemoryAdapter},
@@ -499,8 +506,8 @@ mod tests {
     use std::{path::PathBuf, sync::Arc};
 
     use crate::{
-        signable_builder::SignableBuilderService, CertificateHandler, DumbCertificateHandler,
-        MithrilSingleSigner, MockCertificateHandler, ProtocolInitializerStore, SingleSigner,
+        CertificateHandler, DumbCertificateHandler, MithrilSingleSigner, MockCertificateHandler,
+        ProtocolInitializerStore, SingleSigner,
     };
 
     use super::*;
@@ -536,13 +543,14 @@ mod tests {
 
         let api_version_provider = Arc::new(APIVersionProvider::new(era_checker.clone()));
         let digester = Arc::new(DumbImmutableDigester::new(DIGESTER_RESULT, true));
-        let immutable_signable_builder =
-            CardanoImmutableFilesFullSignableBuilder::new(digester.clone(), slog_scope::logger());
+        let cardano_immutable_signable_builder = Arc::new(
+            CardanoImmutableFilesFullSignableBuilder::new(digester.clone(), slog_scope::logger()),
+        );
         let mithril_stake_distribution_signable_builder =
-            MithrilStakeDistributionSignableBuilder::default();
-        let signable_builder_service = Arc::new(SignableBuilderService::new(
-            immutable_signable_builder,
+            Arc::new(MithrilStakeDistributionSignableBuilder::default());
+        let signable_builder_service = Arc::new(MithrilSignableBuilderService::new(
             mithril_stake_distribution_signable_builder,
+            cardano_immutable_signable_builder,
         ));
 
         SignerServices {
@@ -768,6 +776,8 @@ mod tests {
             .get_current_beacon()
             .await
             .expect("get_current_beacon should not fail");
+        let signed_entity_type =
+            SignedEntityType::CardanoImmutableFilesFull(current_beacon.clone());
         let fixture = MithrilFixtureBuilder::default().with_signers(5).build();
         let signer_with_stake = fixture.signers_fixture()[0].signer_with_stake.clone();
         let protocol_initializer = fixture.signers_fixture()[0].protocol_initializer.clone();
@@ -799,7 +809,7 @@ mod tests {
 
         let runner = init_runner(Some(services), None).await;
         let message = runner
-            .compute_message(&current_beacon, &next_signers)
+            .compute_message(&signed_entity_type, &next_signers)
             .await
             .expect("compute_message should not fail");
 
diff --git a/mithril-signer/src/runtime/signer_services.rs b/mithril-signer/src/runtime/signer_services.rs
@@ -15,7 +15,8 @@ use mithril_common::{
     digesters::{CardanoImmutableDigester, ImmutableDigester, ImmutableFileSystemObserver},
     era::{EraChecker, EraReader},
     signable_builder::{
-        CardanoImmutableFilesFullSignableBuilder, MithrilStakeDistributionSignableBuilder,
+        CardanoImmutableFilesFullSignableBuilder, MithrilSignableBuilderService,
+        MithrilStakeDistributionSignableBuilder, SignableBuilderService,
     },
     store::{adapter::SQLiteAdapter, StakeStore},
     BeaconProvider, BeaconProviderImpl, StdError,
@@ -24,7 +25,7 @@ use mithril_common::{
 use crate::{
     certificate_handler::CertificateHandler, single_signer::SingleSigner,
     CertificateHandlerHTTPClient, Configuration, MithrilSingleSigner, ProtocolInitializerStore,
-    ProtocolInitializerStorer, SignableBuilderService,
+    ProtocolInitializerStorer,
 };
 
 type StakeStoreService = Arc<StakeStore>;
@@ -203,13 +204,14 @@ impl<'a> ServiceBuilder for ProductionServiceBuilder<'a> {
             api_version_provider.clone(),
         ));
 
-        let immutable_snapshot_builder =
-            CardanoImmutableFilesFullSignableBuilder::new(digester.clone(), slog_scope::logger());
+        let cardano_immutable_snapshot_builder = Arc::new(
+            CardanoImmutableFilesFullSignableBuilder::new(digester.clone(), slog_scope::logger()),
+        );
         let mithril_stake_distribution_signable_builder =
-            MithrilStakeDistributionSignableBuilder::default();
-        let signable_builder_service = Arc::new(SignableBuilderService::new(
-            immutable_snapshot_builder,
+            Arc::new(MithrilStakeDistributionSignableBuilder::default());
+        let signable_builder_service = Arc::new(MithrilSignableBuilderService::new(
             mithril_stake_distribution_signable_builder,
+            cardano_immutable_snapshot_builder,
         ));
 
         let services = SignerServices {
@@ -263,7 +265,7 @@ pub struct SignerServices {
     pub api_version_provider: Arc<APIVersionProvider>,
 
     /// Signable Builder Service
-    pub signable_builder_service: Arc<SignableBuilderService>,
+    pub signable_builder_service: Arc<dyn SignableBuilderService>,
 }
 
 #[cfg(test)]
diff --git a/mithril-signer/src/runtime/state_machine.rs b/mithril-signer/src/runtime/state_machine.rs
@@ -360,7 +360,7 @@ impl StateMachine {
 
         let message = self
             .runner
-            .compute_message(current_beacon, &next_signers)
+            .compute_message(&pending_certificate.signed_entity_type, &next_signers)
             .await
             .map_err(|e| RuntimeError::KeepState {
                 message: format!("Could not compute message during 'registered → signed' phase (current beacon {current_beacon:?})"),
diff --git a/mithril-signer/src/signable_builder/mod.rs b/mithril-signer/src/signable_builder/mod.rs
diff --git a/mithril-signer/src/signable_builder/signable_builder_service.rs b/mithril-signer/src/signable_builder/signable_builder_service.rs
diff --git a/mithril-signer/tests/test_extensions/state_machine_tester.rs b/mithril-signer/tests/test_extensions/state_machine_tester.rs
