Merge pull request #1660 from input-output-hk/ensemble/1634-sign-cardano-tx-with-block-range-roots

Sign `Cardano Transactions` with `Block Range Merkle Roots`

Author: jpraynaud

CHANGELOG.md

@@ -7,7 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 As a minor extension, we have adopted a slightly different versioning convention for the Mithril distributions (https://mithril.network/doc/adr/3#decision)
 
-## Mithril Distribution [2416.0] - UNRELEASED
+## Mithril Distribution [XXXX.X] - UNRELEASED
+
+- Support computation of the Cardano Transactions signature with the pre-computed Block Range Merkle Roots retrieved from the database.
+
+## Mithril Distribution [2418.1] - UNRELEASED
 
 - **BREAKING** changes in Mithril client CLI:
   - Certificate chain structure has been modified to remove coupling with immutable file number.

Cargo.lock

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

mithril-aggregator/Cargo.toml

@@ -1,4 +1,8 @@
-use mithril_persistence::sqlite::{Provider, SourceAlias, SqLiteEntity, SqliteConnection};
+use mithril_common::entities::BlockNumber;
+use mithril_persistence::sqlite::{
+    Provider, SourceAlias, SqLiteEntity, SqliteConnection, WhereCondition,
+};
+use sqlite::Value;
 
 use crate::database::record::BlockRangeRootRecord;
 
@@ -8,11 +12,14 @@ pub struct GetBlockRangeRootProvider<'client> {
 }
 
 impl<'client> GetBlockRangeRootProvider<'client> {
-    #[cfg(test)]
     /// Create a new instance
     pub fn new(connection: &'client SqliteConnection) -> Self {
         Self { connection }
     }
+
+    pub fn get_up_to_block_number_condition(&self, block_number: BlockNumber) -> WhereCondition {
+        WhereCondition::new("end < ?*", vec![Value::Integer(block_number as i64)])
+    }
 }
 
 #[cfg(test)]

mithril-aggregator/src/database/provider/block_range_root/get_block_range_root.rs

@@ -2,7 +2,6 @@ mod get_block_range_root;
 mod get_interval_without_block_range_provider;
 mod insert_block_range;
 
-#[cfg(test)]
 pub use get_block_range_root::*;
 pub use get_interval_without_block_range_provider::*;
 pub use insert_block_range::*;

mithril-aggregator/src/database/provider/block_range_root/mod.rs

@@ -2,11 +2,14 @@ use std::ops::Range;
 
 use sqlite::Value;
 
-use mithril_common::entities::{BlockNumber, ImmutableFileNumber, TransactionHash};
+use mithril_common::entities::{BlockNumber, TransactionHash};
 use mithril_persistence::sqlite::{
     Provider, SourceAlias, SqLiteEntity, SqliteConnection, WhereCondition,
 };
 
+#[cfg(test)]
+use mithril_persistence::sqlite::GetAllCondition;
+
 use crate::database::record::CardanoTransactionRecord;
 
 /// Simple queries to retrieve [CardanoTransaction] from the sqlite database.
@@ -40,16 +43,6 @@ impl<'client> GetCardanoTransactionProvider<'client> {
         WhereCondition::where_in("transaction_hash", hashes_values)
     }
 
-    pub fn get_transaction_up_to_beacon_condition(
-        &self,
-        beacon: ImmutableFileNumber,
-    ) -> WhereCondition {
-        WhereCondition::new(
-            "immutable_file_number <= ?*",
-            vec![Value::Integer(beacon as i64)],
-        )
-    }
-
     pub fn get_transaction_between_blocks_condition(
         &self,
         range: Range<BlockNumber>,
@@ -79,3 +72,6 @@ impl<'client> Provider<'client> for GetCardanoTransactionProvider<'client> {
         format!("select {projection} from cardano_tx where {condition} order by rowid")
     }
 }
+
+#[cfg(test)]
+impl GetAllCondition for GetCardanoTransactionProvider<'_> {}

mithril-aggregator/src/database/provider/cardano_transaction/get_cardano_transaction.rs

@@ -9,16 +9,22 @@ use mithril_common::entities::{
     BlockHash, BlockNumber, BlockRange, CardanoDbBeacon, CardanoTransaction, ImmutableFileNumber,
     SlotNumber, TransactionHash,
 };
+use mithril_common::signable_builder::BlockRangeRootRetriever;
 use mithril_common::StdResult;
 use mithril_persistence::sqlite::{Provider, SqliteConnection, WhereCondition};
+use sqlite::Value;
 
 use crate::database::provider::{
-    GetCardanoTransactionProvider, GetIntervalWithoutBlockRangeRootProvider,
-    InsertBlockRangeRootProvider, InsertCardanoTransactionProvider,
+    GetBlockRangeRootProvider, GetCardanoTransactionProvider,
+    GetIntervalWithoutBlockRangeRootProvider, InsertBlockRangeRootProvider,
+    InsertCardanoTransactionProvider,
 };
 use crate::database::record::{BlockRangeRootRecord, CardanoTransactionRecord};
 use crate::services::{TransactionStore, TransactionsRetriever};
 
+#[cfg(test)]
+use mithril_persistence::sqlite::GetAllProvider;
+
 /// ## Cardano transaction repository
 ///
 /// This is a business oriented layer to perform actions on the database through
@@ -55,13 +61,20 @@ impl CardanoTransactionRepository {
     }
 
     /// Return all the [CardanoTransactionRecord]s in the database up to the given beacon using
-    /// chronological order.
+    /// order of insertion.
+    /// Note: until we rely on block number based beacons, this function needs to compute the highest block number for the given immutable file number.
     pub async fn get_transactions_up_to(
         &self,
         beacon: ImmutableFileNumber,
     ) -> StdResult<Vec<CardanoTransactionRecord>> {
+        // Get the highest block number for the given immutable number.
+        // This is a temporary fix that will be removed when the retrieval is based on block number instead of immutable number.
+        let block_number = self
+            .get_highest_block_number_for_immutable_number(beacon)
+            .await?
+            .unwrap_or(0);
         let provider = GetCardanoTransactionProvider::new(&self.connection);
-        let filters = provider.get_transaction_up_to_beacon_condition(beacon);
+        let filters = provider.get_transaction_between_blocks_condition(0..block_number + 1);
         let transactions = provider.find(filters)?;
 
         Ok(transactions.collect())
@@ -130,6 +143,47 @@ impl CardanoTransactionRepository {
 
         Ok(cursor.collect())
     }
+
+    // TODO: remove this function when the Cardano transaction signature is based on block number instead of immutable number
+    async fn get_highest_block_number_for_immutable_number(
+        &self,
+        immutable_file_number: ImmutableFileNumber,
+    ) -> StdResult<Option<BlockNumber>> {
+        let sql =
+            "select max(block_number) as highest from cardano_tx where immutable_file_number <= $1;";
+        match self
+            .connection
+            .prepare(sql)
+            .with_context(|| {
+                format!(
+                    "Prepare query error: SQL=`{}`",
+                    &sql.replace('\n', " ").trim()
+                )
+            })?
+            .iter()
+            .bind::<&[(_, Value)]>(&[(1, Value::Integer(immutable_file_number as i64))])?
+            .next()
+        {
+            None => Ok(None),
+            Some(row) => {
+                let highest = row?.read::<Option<i64>, _>(0);
+                highest
+                    .map(u64::try_from)
+                    .transpose()
+                    .with_context(||
+                        format!("Integer field max(block_number) (value={highest:?}) is incompatible with u64 representation.")
+                    )
+            }
+        }
+    }
+
+    #[cfg(test)]
+    pub(crate) async fn get_all(&self) -> StdResult<Vec<CardanoTransaction>> {
+        let provider = GetCardanoTransactionProvider::new(&self.connection);
+        let records = provider.get_all()?;
+
+        Ok(records.map(|record| record.into()).collect())
+    }
 }
 
 #[cfg(test)]
@@ -261,6 +315,31 @@ impl TransactionsRetriever for CardanoTransactionRepository {
     }
 }
 
+#[async_trait]
+impl BlockRangeRootRetriever for CardanoTransactionRepository {
+    async fn retrieve_block_range_roots(
+        &self,
+        up_to_beacon: ImmutableFileNumber,
+    ) -> StdResult<Box<dyn Iterator<Item = (BlockRange, MKTreeNode)>>> {
+        // Get the highest block number for the given immutable number.
+        // This is a temporary fix that will be removed when the retrieval is based on block number instead of immutable number.
+        let block_number = self
+            .get_highest_block_number_for_immutable_number(up_to_beacon)
+            .await?
+            .unwrap_or(0);
+        let provider = GetBlockRangeRootProvider::new(&self.connection);
+        let filters = provider.get_up_to_block_number_condition(block_number);
+        let block_range_roots = provider.find(filters)?;
+        let block_range_roots = block_range_roots
+            .into_iter()
+            .map(|record| -> (BlockRange, MKTreeNode) { record.into() })
+            .collect::<Vec<_>>() // TODO: remove this collect when we should ba able return the iterator directly
+            .into_iter();
+
+        Ok(Box::new(block_range_roots))
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use mithril_persistence::sqlite::GetAllProvider;
@@ -410,27 +489,34 @@ mod tests {
         let connection = Arc::new(cardano_tx_db_connection().unwrap());
         let repository = CardanoTransactionRepository::new(connection);
 
+        // Build transactions with block numbers from 10 to 40 and immutable file numbers from 12 to 14
         let cardano_transactions: Vec<CardanoTransactionRecord> = (20..=40)
             .map(|i| CardanoTransactionRecord {
                 transaction_hash: format!("tx-hash-{i}"),
-                block_number: i % 10,
+                block_number: i,
                 slot_number: i * 100,
                 block_hash: format!("block-hash-{i}"),
-                immutable_file_number: i,
+                immutable_file_number: i / 10 + 10,
             })
             .collect();
+
         repository
             .create_transactions(cardano_transactions.clone())
             .await
             .unwrap();
 
-        let transaction_result = repository.get_transactions_up_to(34).await.unwrap();
-        assert_eq!(cardano_transactions[0..=14].to_vec(), transaction_result);
+        let transaction_result = repository.get_transactions_up_to(12).await.unwrap();
+        let transaction_up_to_immutable_file_number_12 = cardano_transactions[0..10].to_vec();
+        assert_eq!(
+            transaction_up_to_immutable_file_number_12,
+            transaction_result
+        );
 
         let transaction_result = repository.get_transactions_up_to(300).await.unwrap();
-        assert_eq!(cardano_transactions.clone(), transaction_result);
+        let transaction_all = cardano_transactions[..].to_vec();
+        assert_eq!(transaction_all, transaction_result);
 
-        let transaction_result = repository.get_transactions_up_to(19).await.unwrap();
+        let transaction_result = repository.get_transactions_up_to(9).await.unwrap();
         assert_eq!(Vec::<CardanoTransactionRecord>::new(), transaction_result);
     }
 

mithril-aggregator/src/database/repository/cardano_transaction_repository.rs

@@ -1062,8 +1062,10 @@ impl DependenciesBuilder {
             Some(1),
             self.get_logger().await?,
         ));
+        let block_range_root_retriever = self.get_transaction_repository().await?;
         let cardano_transactions_builder = Arc::new(CardanoTransactionsSignableBuilder::new(
             transactions_importer,
+            block_range_root_retriever,
             self.get_logger().await?,
         ));
         let signable_builder_service = Arc::new(MithrilSignableBuilderService::new(

mithril-aggregator/src/dependency_injection/builder.rs

@@ -174,15 +174,9 @@ impl CardanoTransactionsImporter {
 
 #[async_trait]
 impl TransactionsImporter for CardanoTransactionsImporter {
-    async fn import(
-        &self,
-        up_to_beacon: ImmutableFileNumber,
-    ) -> StdResult<Vec<CardanoTransaction>> {
+    async fn import(&self, up_to_beacon: ImmutableFileNumber) -> StdResult<()> {
         self.import_transactions(up_to_beacon).await?;
-        self.import_block_ranges().await?;
-
-        let transactions = self.transaction_store.get_up_to(up_to_beacon).await?;
-        Ok(transactions)
+        self.import_block_ranges().await
     }
 }
 
@@ -288,7 +282,7 @@ mod tests {
             .await
             .expect("Transactions Importer should succeed");
 
-        let stored_transactions = repository.get_up_to(10000).await.unwrap();
+        let stored_transactions = repository.get_all().await.unwrap();
         assert_eq!(expected_transactions, stored_transactions);
     }
 
@@ -410,7 +404,7 @@ mod tests {
             .await
             .expect("Transactions Importer should succeed");
 
-        let transactions = repository.get_up_to(10000).await.unwrap();
+        let transactions = repository.get_all().await.unwrap();
         assert_eq!(vec![last_tx], transactions);
     }
 
@@ -448,15 +442,15 @@ mod tests {
             CardanoTransactionsImporter::new_for_test(Arc::new(scanner_mock), repository.clone())
         };
 
-        let stored_transactions = repository.get_up_to(10000).await.unwrap();
+        let stored_transactions = repository.get_all().await.unwrap();
         assert_eq!(stored_block.into_transactions(), stored_transactions);
 
         importer
             .import_transactions(up_to_beacon)
             .await
             .expect("Transactions Importer should succeed");
 
-        let stored_transactions = repository.get_up_to(10000).await.unwrap();
+        let stored_transactions = repository.get_all().await.unwrap();
         assert_eq!(expected_transactions, stored_transactions);
     }
 
@@ -619,24 +613,27 @@ mod tests {
             ScannedBlock::new("block_hash-2", 20, 25, 12, vec!["tx_hash-3", "tx_hash-4"]),
         ];
         let transactions = into_transactions(&blocks);
-        let importer = {
-            let connection = cardano_tx_db_connection().unwrap();
-
-            CardanoTransactionsImporter::new_for_test(
+        let (importer, repository) = {
+            let connection = Arc::new(cardano_tx_db_connection().unwrap());
+            let repository = Arc::new(CardanoTransactionRepository::new(connection.clone()));
+            let importer = CardanoTransactionsImporter::new_for_test(
                 Arc::new(DumbBlockScanner::new(blocks.clone())),
-                Arc::new(CardanoTransactionRepository::new(Arc::new(connection))),
-            )
+                Arc::new(CardanoTransactionRepository::new(connection.clone())),
+            );
+            (importer, repository)
         };
 
-        let cold_imported_transactions = importer
+        importer
             .import(12)
             .await
             .expect("Transactions Importer should succeed");
+        let cold_imported_transactions = repository.get_all().await.unwrap();
 
-        let warm_imported_transactions = importer
+        importer
             .import(12)
             .await
             .expect("Transactions Importer should succeed");
+        let warm_imported_transactions = repository.get_all().await.unwrap();
 
         assert_eq!(transactions, cold_imported_transactions);
         assert_eq!(cold_imported_transactions, warm_imported_transactions);