Merge pull request #924 from input-output-hk/jpraynaud/893-implement-artifact-routes

Implement Artifact routes

Author: jpraynaud

Cargo.lock

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

mithril-aggregator/Cargo.toml

@@ -4,7 +4,7 @@ use slog_scope::info;
 use std::sync::Arc;
 
 use mithril_common::{
-    entities::{Beacon, Certificate, Epoch, SignedEntityType, Snapshot},
+    entities::{Beacon, Certificate, Epoch, MithrilStakeDistribution, SignedEntityType, Snapshot},
     signable_builder::Artifact,
     StdResult,
 };
@@ -14,8 +14,6 @@ use crate::{
     database::provider::{SignedEntityRecord, SignedEntityStorer},
 };
 
-use super::MithrilStakeDistribution;
-
 #[cfg(test)]
 use mockall::automock;
 
@@ -123,8 +121,11 @@ 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(Epoch(1), signers_with_stake);
+        let mithril_stake_distribution_expected = MithrilStakeDistribution::new(
+            Epoch(1),
+            signers_with_stake,
+            "certificate-123".to_string(),
+        );
         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

@@ -157,7 +157,7 @@ mod tests {
     #[tokio::test]
     async fn should_compute_valid_artifact() {
         let beacon = fake_data::beacon();
-        let certificate = fake_data::certificate("cert-123".to_string());
+        let certificate = fake_data::certificate("certificate-123".to_string());
         let snapshot_digest = certificate
             .protocol_message
             .get_message_part(&ProtocolMessagePartKey::SnapshotDigest)

mithril-aggregator/src/artifact_builder/cardano_immutable_files_full.rs

@@ -1,56 +1,14 @@
 use async_trait::async_trait;
-use serde::{Deserialize, Serialize};
-use sha2::{Digest, Sha256};
 use std::sync::Arc;
 use tokio::sync::RwLock;
 
 use super::ArtifactBuilder;
 use crate::MultiSigner;
 use mithril_common::{
-    entities::{Certificate, Epoch, SignerWithStake},
-    signable_builder::Artifact,
+    entities::{Certificate, Epoch, MithrilStakeDistribution},
     StdResult,
 };
 
-/// 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(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(),
-        };
-        mithril_stake_distribution.hash = mithril_stake_distribution.compute_hash();
-        mithril_stake_distribution
-    }
-
-    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());
-        }
-        hex::encode(hasher.finalize())
-    }
-}
-
-#[typetag::serde]
-impl Artifact for MithrilStakeDistribution {
-    fn get_id(&self) -> String {
-        self.hash.clone()
-    }
-}
-
 /// A [MithrilStakeDistributionArtifact] builder
 pub struct MithrilStakeDistributionArtifactBuilder {
     multi_signer: Arc<RwLock<dyn MultiSigner>>,
@@ -68,12 +26,13 @@ impl ArtifactBuilder<Epoch, MithrilStakeDistribution> for MithrilStakeDistributi
     async fn compute_artifact(
         &self,
         beacon: Epoch,
-        _certificate: &Certificate,
+        certificate: &Certificate,
     ) -> StdResult<MithrilStakeDistribution> {
         let multi_signer = self.multi_signer.read().await;
         Ok(MithrilStakeDistribution::new(
             beacon,
             multi_signer.get_next_signers_with_stake().await?,
+            certificate.hash.to_owned(),
         ))
     }
 }
@@ -90,7 +49,7 @@ mod tests {
     async fn should_compute_valid_artifact() {
         let signers_with_stake = fake_data::signers_with_stakes(5);
         let signers_with_stake_clone = signers_with_stake.clone();
-        let certificate = fake_data::certificate("cert-123".to_string());
+        let certificate = fake_data::certificate("certificate-123".to_string());
         let mut mock_multi_signer = MockMultiSigner::new();
         mock_multi_signer
             .expect_get_next_signers_with_stake()
@@ -101,7 +60,11 @@ mod tests {
             .compute_artifact(Epoch(1), &certificate)
             .await
             .unwrap();
-        let artifact_expected = MithrilStakeDistribution::new(Epoch(1), signers_with_stake);
+        let artifact_expected = MithrilStakeDistribution::new(
+            Epoch(1),
+            signers_with_stake,
+            "certificate-123".to_string(),
+        );
         assert_eq!(artifact_expected, artifact);
     }
 
@@ -110,18 +73,33 @@ mod tests {
         let signers_with_stake = fake_data::signers_with_stakes(5);
 
         assert_eq!(
-            MithrilStakeDistribution::new(Epoch(1), signers_with_stake.clone()),
-            MithrilStakeDistribution::new(Epoch(1), signers_with_stake.into_iter().rev().collect())
+            MithrilStakeDistribution::new(
+                Epoch(1),
+                signers_with_stake.clone(),
+                "certificate-123".to_string()
+            ),
+            MithrilStakeDistribution::new(
+                Epoch(1),
+                signers_with_stake.into_iter().rev().collect(),
+                "certificate-123".to_string()
+            )
         );
     }
 
     #[test]
     fn hash_value_doesnt_change_if_signers_order_change() {
         let signers_with_stake = fake_data::signers_with_stakes(5);
 
-        let sd = MithrilStakeDistribution::new(Epoch(1), signers_with_stake.clone());
-        let sd2 =
-            MithrilStakeDistribution::new(Epoch(1), signers_with_stake.into_iter().rev().collect());
+        let sd = MithrilStakeDistribution::new(
+            Epoch(1),
+            signers_with_stake.clone(),
+            "certificate-123".to_string(),
+        );
+        let sd2 = MithrilStakeDistribution::new(
+            Epoch(1),
+            signers_with_stake.into_iter().rev().collect(),
+            "certificate-123".to_string(),
+        );
 
         assert_eq!(sd.hash, sd2.hash);
     }

mithril-aggregator/src/artifact_builder/mithril_stake_distribution.rs

@@ -13,9 +13,6 @@ use mithril_common::CardanoNetwork;
 use crate::tools::GcpFileUploader;
 use crate::{LocalSnapshotUploader, RemoteSnapshotUploader, SnapshotUploader};
 
-// TODO: 'LIST_SNAPSHOTS_MAX_ITEMS' keep as const or in config, or add a parameter to `list_snapshots`?
-pub const LIST_SNAPSHOTS_MAX_ITEMS: usize = 20;
-
 /// Different kinds of execution environments
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
 pub enum ExecutionEnvironment {

mithril-aggregator/src/configuration.rs

@@ -743,11 +743,13 @@ mod tests {
     fn get_certificate_record_by_certificate_id() {
         let connection = Connection::open(":memory:").unwrap();
         let provider = CertificateRecordProvider::new(&connection);
-        let condition = provider.condition_by_certificate_id("cert-123").unwrap();
+        let condition = provider
+            .condition_by_certificate_id("certificate-123")
+            .unwrap();
         let (filter, values) = condition.expand();
 
         assert_eq!("certificate_id = ?1".to_string(), filter);
-        assert_eq!(vec![Value::String("cert-123".to_string())], values);
+        assert_eq!(vec![Value::String("certificate-123".to_string())], values);
     }
 
     #[test]

mithril-aggregator/src/database/provider/certificate.rs

@@ -264,6 +264,13 @@ pub trait SignedEntityStorer: Sync + Send {
         &self,
         signed_entity_id: String,
     ) -> StdResult<Option<SignedEntityRecord>>;
+
+    /// Get last signed entities by signed entity type
+    async fn get_last_signed_entities_by_type(
+        &self,
+        signed_entity_type: &SignedEntityType,
+        total: usize,
+    ) -> StdResult<Vec<SignedEntityRecord>>;
 }
 
 /// Service to deal with signed_entity (read & write).
@@ -301,6 +308,21 @@ impl SignedEntityStorer for SignedEntityStoreAdapter {
 
         Ok(signed_entity)
     }
+
+    async fn get_last_signed_entities_by_type(
+        &self,
+        signed_entity_type: &SignedEntityType,
+        total: usize,
+    ) -> StdResult<Vec<SignedEntityRecord>> {
+        let connection = &*self.connection.lock().await;
+        let provider = SignedEntityRecordProvider::new(connection);
+        let cursor = provider
+            .get_by_signed_entity_type(signed_entity_type.to_owned())
+            .map_err(|e| AdapterError::GeneralError(format!("{e}")))?;
+        let signed_entities: Vec<SignedEntityRecord> = cursor.take(total).collect();
+
+        Ok(signed_entities)
+    }
 }
 
 // TODO: this StoreAdapter implementation is temporary and concerns only the snapshots for the CardanoImmutableFilesFull signed entity type

mithril-aggregator/src/database/provider/signed_entity.rs

@@ -16,6 +16,7 @@ use sqlite::Connection;
 use std::{collections::HashMap, sync::Arc};
 use tokio::sync::{Mutex, RwLock};
 
+use crate::event_store::EventMessage;
 use crate::{
     artifact_builder::ArtifactBuilderService,
     certifier_service::CertifierService,
@@ -27,7 +28,6 @@ use crate::{
     SignerRegisterer, SignerRegistrationRoundOpener, Snapshotter, VerificationKeyStore,
     VerificationKeyStorer,
 };
-use crate::{event_store::EventMessage, snapshot_stores::SnapshotStore};
 use crate::{event_store::TransmitterService, multi_signer::MultiSigner};
 use crate::{
     snapshot_uploaders::SnapshotUploader, stake_distribution_service::StakeDistributionService,
@@ -50,9 +50,6 @@ pub struct DependencyManager {
     /// It shall be a private dependency.
     pub stake_store: Arc<StakePoolStore>,
 
-    /// Snapshot store.
-    pub snapshot_store: Arc<dyn SnapshotStore>,
-
     /// Snapshot uploader service.
     pub snapshot_uploader: Arc<dyn SnapshotUploader>,
 

mithril-aggregator/src/dependency.rs

@@ -41,7 +41,7 @@ use crate::{
         MithrilArtifactBuilderService, MithrilStakeDistributionArtifactBuilder,
     },
     certifier_service::{CertifierService, MithrilCertifierService},
-    configuration::{ExecutionEnvironment, LIST_SNAPSHOTS_MAX_ITEMS},
+    configuration::ExecutionEnvironment,
     database::provider::{
         CertificateRepository, CertificateStoreAdapter, EpochSettingStore, OpenMessageRepository,
         SignedEntityStoreAdapter, SignedEntityStorer, SignerRegistrationStoreAdapter, SignerStore,
@@ -55,10 +55,9 @@ use crate::{
     tools::{GcpFileUploader, GenesisToolsDependency},
     AggregatorConfig, AggregatorRunner, AggregatorRuntime, CertificatePendingStore,
     CertificateStore, Configuration, DependencyManager, DumbSnapshotUploader, DumbSnapshotter,
-    GzipSnapshotter, LocalSnapshotStore, LocalSnapshotUploader, MithrilSignerRegisterer,
-    MultiSigner, MultiSignerImpl, ProtocolParametersStore, ProtocolParametersStorer,
-    RemoteSnapshotUploader, SnapshotStore, SnapshotUploader, SnapshotUploaderType, Snapshotter,
-    VerificationKeyStore,
+    GzipSnapshotter, LocalSnapshotUploader, MithrilSignerRegisterer, MultiSigner, MultiSignerImpl,
+    ProtocolParametersStore, ProtocolParametersStorer, RemoteSnapshotUploader, SnapshotUploader,
+    SnapshotUploaderType, Snapshotter, VerificationKeyStore,
 };
 
 use super::{DependenciesBuilderError, Result};
@@ -87,9 +86,6 @@ pub struct DependenciesBuilder {
     /// It shall be a private dependency.
     pub stake_store: Option<Arc<StakePoolStore>>,
 
-    /// Snapshot store.
-    pub snapshot_store: Option<Arc<dyn SnapshotStore>>,
-
     /// Snapshot uploader service.
     pub snapshot_uploader: Option<Arc<dyn SnapshotUploader>>,
 
@@ -191,7 +187,6 @@ impl DependenciesBuilder {
             configuration,
             sqlite_connection: None,
             stake_store: None,
-            snapshot_store: None,
             snapshot_uploader: None,
             multi_signer: None,
             certificate_pending_store: None,
@@ -291,24 +286,6 @@ impl DependenciesBuilder {
         Ok(self.stake_store.as_ref().cloned().unwrap())
     }
 
-    async fn build_snapshot_store(&mut self) -> Result<Arc<dyn SnapshotStore>> {
-        Ok(Arc::new(LocalSnapshotStore::new(
-            Box::new(SignedEntityStoreAdapter::new(
-                self.get_sqlite_connection().await?,
-            )),
-            LIST_SNAPSHOTS_MAX_ITEMS,
-        )))
-    }
-
-    /// Return a configured [SnapshotStore]
-    pub async fn get_snapshot_store(&mut self) -> Result<Arc<dyn SnapshotStore>> {
-        if self.snapshot_store.is_none() {
-            self.snapshot_store = Some(self.build_snapshot_store().await?);
-        }
-
-        Ok(self.snapshot_store.as_ref().cloned().unwrap())
-    }
-
     async fn build_snapshot_uploader(&mut self) -> Result<Arc<dyn SnapshotUploader>> {
         if self.configuration.environment == ExecutionEnvironment::Production {
             match self.configuration.snapshot_uploader_type {
@@ -960,7 +937,6 @@ impl DependenciesBuilder {
             config: self.configuration.clone(),
             sqlite_connection: self.get_sqlite_connection().await?,
             stake_store: self.get_stake_store().await?,
-            snapshot_store: self.get_snapshot_store().await?,
             snapshot_uploader: self.get_snapshot_uploader().await?,
             multi_signer: self.get_multi_signer().await?,
             certificate_pending_store: self.get_certificate_pending_store().await?,