Add ArtifactBuilder trait

Author: jpraynaud

mithril-aggregator/src/artifact_builder/dummy_artifact.rs

@@ -0,0 +1,58 @@
+use std::marker::PhantomData;
+
+use async_trait::async_trait;
+use mithril_common::{entities::Certificate, signable_builder::DummyBeacon, StdResult};
+use serde::{Deserialize, Serialize};
+
+use crate::artifact_builder::{Artifact, ArtifactBuilder};
+
+/// Dummy artifact
+#[derive(Serialize, Deserialize, PartialEq, Debug)]
+pub struct DummyArtifact<'a> {
+    message: String,
+    beacon: DummyBeacon,
+    phantom: PhantomData<&'a DummyBeacon>,
+}
+
+impl<'a> DummyArtifact<'a> {
+    /// Dummy artifact factory
+    pub fn new(message: String, beacon: DummyBeacon) -> Self {
+        Self {
+            message,
+            beacon,
+            phantom: PhantomData,
+        }
+    }
+}
+
+impl<'a> Artifact<'a> for DummyArtifact<'a> {}
+
+/// A [DummyArtifact] builder
+pub struct DummyArtifactBuilder {}
+
+impl DummyArtifactBuilder {
+    /// Dummy artifact builder factory
+    pub fn new() -> Self {
+        Self {}
+    }
+}
+
+impl Default for DummyArtifactBuilder {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
+#[async_trait]
+impl<'a> ArtifactBuilder<'a, DummyBeacon, DummyArtifact<'a>> for DummyArtifactBuilder {
+    async fn compute_artifact(
+        &'a self,
+        beacon: DummyBeacon,
+        certificate: Certificate,
+    ) -> StdResult<DummyArtifact> {
+        Ok(DummyArtifact::new(
+            format!("certificate id is {}", certificate.hash),
+            beacon,
+        ))
+    }
+}

mithril-aggregator/src/artifact_builder/interface.rs

@@ -0,0 +1,18 @@
+use async_trait::async_trait;
+use mithril_common::{entities::Certificate, signable_builder::Beacon, StdResult};
+use serde::{Deserialize, Serialize};
+use std::fmt::Debug;
+
+/// Artifact is a trait for types that represent signed artifacts
+pub trait Artifact<'a>: Serialize + Deserialize<'a> + PartialEq + Debug {}
+
+/// ArtifactBuilder is trait for building an artifact
+#[async_trait]
+pub trait ArtifactBuilder<'a, U, W>
+where
+    U: Beacon,
+    W: Artifact<'a>,
+{
+    /// Compute an artifact
+    async fn compute_artifact(&'a self, beacon: U, certificate: Certificate) -> StdResult<W>;
+}

mithril-aggregator/src/artifact_builder/mod.rs

@@ -0,0 +1,7 @@
+//! The module used for building artifact
+
+mod dummy_artifact;
+mod interface;
+
+pub use dummy_artifact::*;
+pub use interface::*;

mithril-aggregator/src/lib.rs

@@ -11,6 +11,7 @@
 //! signed certificates.
 //! You can find more information on how it works reading the [documentation website](https://mithril.network/doc/mithril/mithril-network/aggregator).
 
+mod artifact_builder;
 mod certificate_creator;
 mod command_args;
 mod configuration;