Merge pull request #2142 from input-output-hk/dlachaume/2121/create-new-signed-entity-type-for-incremental-cardano-db

Feat: create new signed entity type for Incremental Cardano DB

Author: dlachaume

CHANGELOG.md

@@ -22,6 +22,10 @@ As a minor extension, we have adopted a slightly different versioning convention
 
 - Add a one line shell installation script for the Mithril nodes.
 
+- **UNSTABLE** Cardano database incremental certification:
+
+  - Implement the new signed entity type `CardanoDatabase`.
+
 - Crates versions:
 
 | Crate | Version |

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-persistence"
-version = "0.2.35"
+version = "0.2.36"
 description = "Common types, interfaces, and utilities to persist data for Mithril nodes."
 authors = { workspace = true }
 edition = { workspace = true }

internal/mithril-persistence/Cargo.toml

@@ -85,6 +85,14 @@ impl Hydrator {
                     })?;
                 SignedEntityType::CardanoTransactions(beacon.epoch, beacon.block_number)
             }
+            SignedEntityTypeDiscriminants::CardanoDatabase => {
+                let beacon: CardanoDbBeacon = serde_json::from_str(beacon_str).map_err(|e| {
+                    HydrationError::InvalidData(format!(
+                        "Invalid Beacon JSON in open_message.beacon: '{beacon_str}'. Error: {e}"
+                    ))
+                })?;
+                SignedEntityType::CardanoDatabase(beacon)
+            }
         };
 
         Ok(signed_entity)
@@ -106,4 +114,16 @@ mod tests {
 
         assert_eq!(expected, signed_entity);
     }
+
+    #[test]
+    fn hydrate_cardano_database_signed_entity_type() {
+        let expected = SignedEntityType::CardanoDatabase(CardanoDbBeacon::new(84, 239));
+        let signed_entity = Hydrator::hydrate_signed_entity_type(
+            SignedEntityTypeDiscriminants::CardanoDatabase.index(),
+            &expected.get_json_beacon().unwrap(),
+        )
+        .unwrap();
+
+        assert_eq!(expected, signed_entity);
+    }
 }

internal/mithril-persistence/src/database/hydrator.rs

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

mithril-aggregator/Cargo.toml

@@ -847,5 +847,14 @@ update certificate
     where certificate.signed_entity_type_id = 2;
         "#,
         ),
+        // Migration 32
+        // Add the `signed_entity_type` record for 'CardanoDatabase'
+        SqlMigration::new(
+            32,
+            r#"
+insert into signed_entity_type (signed_entity_type_id, name) 
+    values  (4, 'Cardano Database');
+"#,
+        ),
     ]
 }

mithril-aggregator/src/database/migration.rs

@@ -66,6 +66,10 @@ build_metrics_service!(
         "mithril_aggregator_artifact_cardano_transaction_total_produced_since_startup",
         "Number of Cardano transaction artifacts produced since startup on a Mithril aggregator node"
     ),
+    artifact_cardano_database_total_produced_since_startup:MetricCounter(
+        "mithril_aggregator_artifact_cardano_database_total_produced_since_startup",
+        "Number of Cardano database artifacts produced since startup on a Mithril aggregator node"
+    ),
     runtime_cycle_success_since_startup:MetricCounter(
         "mithril_aggregator_runtime_cycle_success_since_startup",
         "Number of successful runtime cycles since startup on a Mithril aggregator"

mithril-aggregator/src/metrics/service.rs

@@ -191,6 +191,9 @@ impl AggregatorRunner {
             SignedEntityType::CardanoTransactions(_, _) => {
                 metrics.get_artifact_cardano_transaction_total_produced_since_startup()
             }
+            SignedEntityType::CardanoDatabase(_) => {
+                metrics.get_artifact_cardano_database_total_produced_since_startup()
+            }
         };
 
         metric_counter.increment();

mithril-aggregator/src/runtime/runner.rs

@@ -210,6 +210,11 @@ impl MithrilSignedEntityService {
                         )
                     })?,
             )),
+            SignedEntityType::CardanoDatabase(_) => {
+                Err(anyhow::anyhow!(
+                    "Signable builder service can not compute artifact for Cardano database because it is not yet implemented."
+                ))
+            }
         }
     }
 
@@ -721,6 +726,20 @@ mod tests {
         .await;
     }
 
+    #[tokio::test]
+    async fn build_cardano_database_artifact_when_given_cardano_database_entity_type_return_error()
+    {
+        let mock_container = MockDependencyInjector::new();
+        let artifact_builder_service = mock_container.build_artifact_builder_service();
+        let certificate = fake_data::certificate("hash".to_string());
+        let signed_entity_type = SignedEntityType::CardanoDatabase(CardanoDbBeacon::default());
+
+        artifact_builder_service
+            .compute_artifact(signed_entity_type.clone(), &certificate)
+            .await
+            .expect_err("Should return error because CardanoDatabase is not implemented yet.");
+    }
+
     async fn generic_test_that_the_artifact_is_stored<
         T: Artifact + Clone + Serialize + 'static,
         U: signable_builder::Beacon,

mithril-aggregator/src/services/signed_entity.rs

@@ -288,6 +288,12 @@ mod test {
                     SignedEntityType::CardanoTransactions(epoch, block_number) => {
                         format!("cardano-transactions-{epoch}-{block_number}",)
                     }
+                    SignedEntityType::CardanoDatabase(beacon) => {
+                        format!(
+                            "cardano-database-{}-{}",
+                            beacon.epoch, beacon.immutable_file_number
+                        )
+                    }
                 };
 
                 let signed_entity_record = SignedEntityRecord {

mithril-aggregator/src/tools/certificates_hash_migrator.rs

@@ -138,6 +138,8 @@ impl AggregatorObserver {
                     .await?
                     .first()
                     .map(|s| &s.signed_entity_type)),
+            // TODO: This case will be implemented once the signable and artifact builders are available.
+            SignedEntityType::CardanoDatabase(_) => Ok(false),
         }
     }
 }

mithril-aggregator/tests/test_extensions/aggregator_observer.rs

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-common"
-version = "0.4.88"
+version = "0.4.89"
 description = "Common types, interfaces, and utilities for Mithril nodes."
 authors = { workspace = true }
 edition = { workspace = true }

mithril-common/Cargo.toml

@@ -84,6 +84,9 @@ impl SignedEntityConfig {
                         .compute_block_number_to_be_signed(time_point.chain_point.block_number),
                 )
             }
+            SignedEntityTypeDiscriminants::CardanoDatabase => SignedEntityType::CardanoDatabase(
+                CardanoDbBeacon::new(*time_point.epoch, time_point.immutable_file_number),
+            ),
         };
 
         Ok(signed_entity_type)
@@ -239,6 +242,16 @@ mod tests {
                 )
                 .unwrap()
         );
+
+        assert_eq!(
+            SignedEntityType::CardanoDatabase(CardanoDbBeacon::new(1, 5)),
+            config
+                .time_point_to_signed_entity(
+                    SignedEntityTypeDiscriminants::CardanoDatabase,
+                    &time_point
+                )
+                .unwrap()
+        );
     }
 
     #[test]
@@ -372,6 +385,7 @@ mod tests {
             allowed_discriminants: BTreeSet::from([
                 SignedEntityTypeDiscriminants::CardanoStakeDistribution,
                 SignedEntityTypeDiscriminants::CardanoTransactions,
+                SignedEntityTypeDiscriminants::CardanoDatabase,
             ]),
             ..SignedEntityConfig::dummy()
         };
@@ -381,11 +395,13 @@ mod tests {
         assert_eq!(
             BTreeSet::from_iter(
                 [
-                    SignedEntityConfig::DEFAULT_ALLOWED_DISCRIMINANTS,
+                    SignedEntityConfig::DEFAULT_ALLOWED_DISCRIMINANTS.as_slice(),
                     [
                         SignedEntityTypeDiscriminants::CardanoStakeDistribution,
                         SignedEntityTypeDiscriminants::CardanoTransactions,
+                        SignedEntityTypeDiscriminants::CardanoDatabase
                     ]
+                    .as_slice()
                 ]
                 .concat()
             ),