Add slot_number and block_hash to CardanoTransaction

Author: sfauvel

mithril-aggregator/src/database/cardano_transaction_migration.rs

@@ -37,5 +37,19 @@ create index cardano_tx_immutable_file_number_index on cardano_tx(immutable_file
 vacuum;
 "#,
         ),
+        // Migration 3
+        // Add `slot_number` and `block_hash` columns to `cardano_tx`.
+        SqlMigration::new(
+            3,
+            r#"
+-- remove all data from the cardano tx table since the new columns are mandatory
+delete from cardano_tx;
+
+alter table cardano_tx add column slot_number integer not null;
+alter table cardano_tx add column block_hash text not null;
+
+vacuum;
+        "#,
+        ),
     ]
 }

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

@@ -140,8 +140,14 @@ mod tests {
         let mut transactions = vec![];
 
         for i in 1..=total_transactions {
-            let hash = format!("tx-{}", i);
-            transactions.push(CardanoTransaction::new(&hash, 10 * i as u64, i as u64));
+            let hash = format!("tx-{i}");
+            transactions.push(CardanoTransaction::new(
+                &hash,
+                10 * i as u64,
+                100 * i as u64,
+                format!("block_hash-{i}"),
+                i as u64,
+            ));
             hashes.push(hash);
         }
 

mithril-aggregator/src/services/prover.rs

@@ -2,7 +2,8 @@
 use crate::{
     digesters::ImmutableFile,
     entities::{
-        BlockNumber, CardanoDbBeacon, CardanoTransaction, ImmutableFileNumber, TransactionHash,
+        BlockHash, BlockNumber, CardanoDbBeacon, CardanoTransaction, ImmutableFileNumber,
+        SlotNumber, TransactionHash,
     },
     StdResult,
 };
@@ -95,6 +96,8 @@ struct Block {
     pub block_number: BlockNumber,
     pub immutable_file_number: ImmutableFileNumber,
     pub transactions: Vec<TransactionHash>,
+    pub slot_number: SlotNumber,
+    pub block_hash: BlockHash,
 }
 
 impl Block {
@@ -103,11 +106,12 @@ impl Block {
         for tx in &multi_era_block.txs() {
             transactions.push(tx.hash().to_string());
         }
-
         Block {
             block_number: multi_era_block.number(),
             immutable_file_number,
             transactions,
+            slot_number: multi_era_block.slot(),
+            block_hash: multi_era_block.hash().to_string(),
         }
     }
 }
@@ -218,14 +222,15 @@ impl TransactionParser for CardanoTransactionParser {
             let mut block_transactions = blocks
                 .into_iter()
                 .flat_map(|block| {
-                    block
-                        .transactions
-                        .into_iter()
-                        .map(move |transaction_hash| CardanoTransaction {
+                    block.transactions.into_iter().map(move |transaction_hash| {
+                        CardanoTransaction::new(
                             transaction_hash,
-                            block_number: block.block_number,
-                            immutable_file_number: block.immutable_file_number,
-                        })
+                            block.block_number,
+                            block.slot_number,
+                            block.block_hash.clone(),
+                            block.immutable_file_number,
+                        )
+                    })
                 })
                 .collect::<Vec<_>>();
 

mithril-common/src/cardano_transaction_parser.rs

@@ -4,6 +4,10 @@ use super::{BlockNumber, ImmutableFileNumber};
 
 /// TransactionHash is the unique identifier of a cardano transaction.
 pub type TransactionHash = String;
+/// Hash of a Cardano Block
+pub type BlockHash = String;
+/// [Cardano Slot number](https://docs.cardano.org/learn/cardano-node/#slotsandepochs)
+pub type SlotNumber = u64;
 
 #[derive(Debug, PartialEq, Clone)]
 /// Cardano transaction representation
@@ -14,20 +18,30 @@ pub struct CardanoTransaction {
     /// Block number of the transaction
     pub block_number: BlockNumber,
 
+    /// Slot number of the transaction
+    pub slot_number: SlotNumber,
+
+    /// Block hash of the transaction
+    pub block_hash: BlockHash,
+
     /// Immutable file number of the transaction
     pub immutable_file_number: ImmutableFileNumber,
 }
 
 impl CardanoTransaction {
     /// CardanoTransaction factory
-    pub fn new(
-        hash: &str,
+    pub fn new<T: Into<TransactionHash>, U: Into<BlockHash>>(
+        hash: T,
         block_number: BlockNumber,
+        slot_number: SlotNumber,
+        block_hash: U,
         immutable_file_number: ImmutableFileNumber,
     ) -> Self {
         Self {
-            transaction_hash: hash.to_owned(),
+            transaction_hash: hash.into(),
             block_number,
+            slot_number,
+            block_hash: block_hash.into(),
             immutable_file_number,
         }
     }
@@ -51,11 +65,8 @@ mod tests {
 
     #[test]
     fn test_convert_cardano_transaction_to_merkle_tree_node() {
-        let transaction = CardanoTransaction {
-            transaction_hash: "tx-hash-123".to_string(),
-            block_number: 1,
-            immutable_file_number: 1,
-        };
+        let transaction = CardanoTransaction::new("tx-hash-123", 10, 4, "block_hash", 1);
+
         let computed_mktree_node: MKTreeNode = transaction.into();
         let expected_mk_tree_node = MKTreeNode::new("tx-hash-123".as_bytes().to_vec());
         let non_expected_mk_tree_node = MKTreeNode::new("tx-hash-456".as_bytes().to_vec());

mithril-common/src/entities/cardano_transaction.rs

@@ -26,7 +26,7 @@ mod type_alias;
 pub use block_range::{BlockNumber, BlockRange, BlockRangeLength};
 pub use cardano_db_beacon::CardanoDbBeacon;
 pub use cardano_network::CardanoNetwork;
-pub use cardano_transaction::{CardanoTransaction, TransactionHash};
+pub use cardano_transaction::{BlockHash, CardanoTransaction, SlotNumber, TransactionHash};
 pub use cardano_transactions_set_proof::CardanoTransactionsSetProof;
 pub use cardano_transactions_snapshot::CardanoTransactionsSnapshot;
 pub use certificate::{Certificate, CertificateSignature};

mithril-common/src/entities/mod.rs

@@ -328,8 +328,8 @@ mod tests {
         async fn verify_hashes_from_verified_cardano_transaction_and_from_signable_builder_are_equals(
         ) {
             let transactions = vec![
-                CardanoTransaction::new("tx-hash-123", 1, 1),
-                CardanoTransaction::new("tx-hash-456", 2, 1),
+                CardanoTransaction::new("tx-hash-123", 10, 1, "block_hash", 1),
+                CardanoTransaction::new("tx-hash-456", 20, 2, "block_hash", 1),
             ];
 
             assert_eq!(

mithril-common/src/messages/cardano_transactions_proof.rs

@@ -159,10 +159,10 @@ mod tests {
 
     #[tokio::test]
     async fn test_compute_merkle_root() {
-        let transaction_1 = CardanoTransaction::new("tx-hash-123", 1, 1);
-        let transaction_2 = CardanoTransaction::new("tx-hash-456", 2, 1);
-        let transaction_3 = CardanoTransaction::new("tx-hash-789", 3, 1);
-        let transaction_4 = CardanoTransaction::new("tx-hash-abc", 4, 1);
+        let transaction_1 = CardanoTransaction::new("tx-hash-123", 10, 1, "block_hash", 1);
+        let transaction_2 = CardanoTransaction::new("tx-hash-456", 20, 2, "block_hash", 1);
+        let transaction_3 = CardanoTransaction::new("tx-hash-789", 30, 3, "block_hash", 1);
+        let transaction_4 = CardanoTransaction::new("tx-hash-abc", 40, 4, "block_hash", 1);
 
         let transactions_set_reference = vec![
             transaction_1.clone(),
@@ -230,9 +230,9 @@ mod tests {
             ..CardanoDbBeacon::default()
         };
         let transactions = vec![
-            CardanoTransaction::new("tx-hash-123", 1, 11),
-            CardanoTransaction::new("tx-hash-456", 2, 12),
-            CardanoTransaction::new("tx-hash-789", 3, 13),
+            CardanoTransaction::new("tx-hash-123", 10, 1, "block_hash-", 11),
+            CardanoTransaction::new("tx-hash-456", 20, 2, "block_hash", 12),
+            CardanoTransaction::new("tx-hash-789", 30, 3, "block_hash", 13),
         ];
         let transaction_parser = Arc::new(DumbTransactionParser::new(transactions.clone()));
         let mut mock_transaction_store = MockTransactionStore::new();

mithril-common/src/signable_builder/cardano_transactions.rs

@@ -37,5 +37,19 @@ create index cardano_tx_immutable_file_number_index on cardano_tx(immutable_file
 vacuum;
 "#,
         ),
+        // Migration 3
+        // Add `slot_number` and `block_hash` columns to `cardano_tx`.
+        SqlMigration::new(
+            3,
+            r#"
+-- remove all data from the cardano tx table since the new columns are mandatory
+delete from cardano_tx;
+
+alter table cardano_tx add column slot_number integer not null;
+alter table cardano_tx add column block_hash text not null;
+
+vacuum;
+        "#,
+        ),
     ]
 }