Merge pull request #908 from input-output-hk/ensemble/907-handle-multiple-signed-entity-types-runtime-aggregator

Handle multiple Signed Entity Types in aggregator runtime

Author: jpraynaud

Cargo.lock

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

mithril-aggregator/Cargo.toml

@@ -1,6 +1,6 @@
 use async_trait::async_trait;
 use chrono::Utc;
-
+use slog_scope::info;
 use std::sync::Arc;
 
 use mithril_common::{
@@ -84,6 +84,12 @@ impl ArtifactBuilderService for MithrilArtifactBuilderService {
         signed_entity_type: SignedEntityType,
         certificate: &Certificate,
     ) -> StdResult<()> {
+        info!(
+            "MithrilArtifactBuilderService::create_artifact";
+            "signed_entity_type" => ?signed_entity_type,
+            "certificate_hash" => &certificate.hash
+        );
+
         let artifact = self
             .compute_artifact(signed_entity_type.clone(), certificate)
             .await?;
@@ -117,7 +123,8 @@ mod tests {
     async fn build_mithril_stake_distribution_artifact_when_given_mithril_stake_distribution_entity_type(
     ) {
         let signers_with_stake = fake_data::signers_with_stakes(5);
-        let mithril_stake_distribution_expected = MithrilStakeDistribution::new(signers_with_stake);
+        let mithril_stake_distribution_expected =
+            MithrilStakeDistribution::new(Epoch(1), signers_with_stake);
         let mithril_stake_distribution_clone = mithril_stake_distribution_expected.clone();
 
         let mock_signed_entity_storer = MockSignedEntityStorer::new();

mithril-aggregator/src/artifact_builder/artifact_builder_service.rs

@@ -15,16 +15,18 @@ use mithril_common::{
 /// Mithril Stake Distribution
 #[derive(Debug, PartialEq, Serialize, Deserialize, Clone)]
 pub struct MithrilStakeDistribution {
+    epoch: Epoch,
     signers_with_stake: Vec<SignerWithStake>,
     hash: String,
 }
 
 impl MithrilStakeDistribution {
     /// MithrilStakeDistribution artifact factory
-    pub fn new(signers_with_stake: Vec<SignerWithStake>) -> Self {
+    pub fn new(epoch: Epoch, signers_with_stake: Vec<SignerWithStake>) -> Self {
         let mut signers_with_stake_sorted = signers_with_stake;
         signers_with_stake_sorted.sort();
         let mut mithril_stake_distribution = Self {
+            epoch,
             signers_with_stake: signers_with_stake_sorted,
             hash: "".to_string(),
         };
@@ -34,6 +36,7 @@ impl MithrilStakeDistribution {
 
     fn compute_hash(&self) -> String {
         let mut hasher = Sha256::new();
+        hasher.update(self.epoch.0.to_be_bytes());
         for signer_with_stake in &self.signers_with_stake {
             hasher.update(signer_with_stake.compute_hash().as_bytes());
         }
@@ -64,11 +67,12 @@ impl MithrilStakeDistributionArtifactBuilder {
 impl ArtifactBuilder<Epoch, MithrilStakeDistribution> for MithrilStakeDistributionArtifactBuilder {
     async fn compute_artifact(
         &self,
-        _beacon: Epoch,
+        beacon: Epoch,
         _certificate: &Certificate,
     ) -> StdResult<MithrilStakeDistribution> {
         let multi_signer = self.multi_signer.read().await;
         Ok(MithrilStakeDistribution::new(
+            beacon,
             multi_signer.get_next_signers_with_stake().await?,
         ))
     }
@@ -97,7 +101,7 @@ mod tests {
             .compute_artifact(Epoch(1), &certificate)
             .await
             .unwrap();
-        let artifact_expected = MithrilStakeDistribution::new(signers_with_stake);
+        let artifact_expected = MithrilStakeDistribution::new(Epoch(1), signers_with_stake);
         assert_eq!(artifact_expected, artifact);
     }
 
@@ -106,17 +110,18 @@ mod tests {
         let signers_with_stake = fake_data::signers_with_stakes(5);
 
         assert_eq!(
-            MithrilStakeDistribution::new(signers_with_stake.clone()),
-            MithrilStakeDistribution::new(signers_with_stake.into_iter().rev().collect())
+            MithrilStakeDistribution::new(Epoch(1), signers_with_stake.clone()),
+            MithrilStakeDistribution::new(Epoch(1), signers_with_stake.into_iter().rev().collect())
         );
     }
 
     #[test]
     fn hash_value_doesnt_change_if_signers_order_change() {
         let signers_with_stake = fake_data::signers_with_stakes(5);
 
-        let sd = MithrilStakeDistribution::new(signers_with_stake.clone());
-        let sd2 = MithrilStakeDistribution::new(signers_with_stake.into_iter().rev().collect());
+        let sd = MithrilStakeDistribution::new(Epoch(1), signers_with_stake.clone());
+        let sd2 =
+            MithrilStakeDistribution::new(Epoch(1), signers_with_stake.into_iter().rev().collect());
 
         assert_eq!(sd.hash, sd2.hash);
     }

mithril-aggregator/src/artifact_builder/mithril_stake_distribution.rs

@@ -226,7 +226,6 @@ impl CertifierService for MithrilCertifierService {
     ) -> StdResult<OpenMessage> {
         debug!("CertifierService::create_open_message(signed_entity_type: {signed_entity_type:?}, protocol_message: {protocol_message:?})");
         let current_epoch = self.current_epoch.read().await;
-
         let open_message = self
             .open_message_repository
             .create_open_message(*current_epoch, signed_entity_type, protocol_message)

mithril-aggregator/src/certifier_service.rs

@@ -297,9 +297,35 @@ alter table open_message add column is_certified bool not null default false;
         SqlMigration::new(
             11,
             r#"
-alter table signed_entity add column artifact json not null;
-update signed_entity set artifact = entity;
-alter table signed_entity drop column entity;
+alter table signed_entity rename to signed_entity_old;
+create table signed_entity (
+    signed_entity_id            text        not null,
+    signed_entity_type_id       integer     not null,
+    certificate_id              text        not null,
+    beacon                      json        not null,
+    artifact                    json        not null,
+    created_at                  text        not null default current_timestamp,
+    primary key (signed_entity_id)
+    foreign key (signed_entity_type_id) references signed_entity_type(signed_entity_type_id)
+    foreign key (certificate_id) references certificate(certificate_id)
+);
+insert into signed_entity (signed_entity_id, 
+    signed_entity_type_id, 
+    certificate_id,
+    beacon,
+    artifact, created_at) 
+    select signed_entity_id, signed_entity_type_id, certificate_id, beacon, entity, created_at
+    from signed_entity_old 
+    order by rowid asc;
+drop table signed_entity_old;
+"#,
+        ),
+        // Migration 12
+        // Alter `open_message` table
+        SqlMigration::new(
+            12,
+            r#"
+create unique index open_message_unique_index on open_message(signed_entity_type_id, beacon);
 "#,
         ),
     ]