refactor: create method BlockMerkleRoots::from_transactions

Author: tmpolaczyk

data_structures/src/chain.rs

@@ -668,6 +668,36 @@ pub struct BlockMerkleRoots {
     pub tally_hash_merkle_root: Hash,
 }
 
+/// Function to calculate a merkle tree from a transaction vector
+pub fn merkle_tree_root<T>(transactions: &[T]) -> Hash
+where
+    T: Hashable,
+{
+    let transactions_hashes: Vec<Sha256> = transactions
+        .iter()
+        .map(|x| match x.hash() {
+            Hash::SHA256(x) => Sha256(x),
+        })
+        .collect();
+
+    Hash::from(witnet_crypto::merkle::merkle_tree_root(
+        &transactions_hashes,
+    ))
+}
+
+impl BlockMerkleRoots {
+    pub fn from_transactions(txns: &BlockTransactions) -> Self {
+        BlockMerkleRoots {
+            mint_hash: txns.mint.hash(),
+            vt_hash_merkle_root: merkle_tree_root(&txns.value_transfer_txns),
+            dr_hash_merkle_root: merkle_tree_root(&txns.data_request_txns),
+            commit_hash_merkle_root: merkle_tree_root(&txns.commit_txns),
+            reveal_hash_merkle_root: merkle_tree_root(&txns.reveal_txns),
+            tally_hash_merkle_root: merkle_tree_root(&txns.tally_txns),
+        }
+    }
+}
+
 /// `SuperBlock` abridges the tally and data request information that happened during a
 /// `superblock_period` number of Witnet epochs as well the ARS members merkle root
 /// as of the last block in that period.

data_structures/tests/inclusion_proofs.rs

@@ -1,37 +1,10 @@
 use std::convert::TryFrom;
 use witnet_crypto::{
     hash::Sha256,
-    merkle::{merkle_tree_root as crypto_merkle_tree_root, sha256_concat, InclusionProof},
+    merkle::{sha256_concat, InclusionProof},
 };
 use witnet_data_structures::{chain::*, transaction::*};
 
-/// Function to calculate a merkle tree from a transaction vector
-pub fn merkle_tree_root<T>(transactions: &[T]) -> Hash
-where
-    T: Hashable,
-{
-    let transactions_hashes: Vec<Sha256> = transactions
-        .iter()
-        .map(|x| match x.hash() {
-            Hash::SHA256(x) => Sha256(x),
-        })
-        .collect();
-
-    Hash::from(crypto_merkle_tree_root(&transactions_hashes))
-}
-
-fn build_merkle_tree(block_header: &mut BlockHeader, txns: &BlockTransactions) {
-    let merkle_roots = BlockMerkleRoots {
-        mint_hash: txns.mint.hash(),
-        vt_hash_merkle_root: merkle_tree_root(&txns.value_transfer_txns),
-        dr_hash_merkle_root: merkle_tree_root(&txns.data_request_txns),
-        commit_hash_merkle_root: merkle_tree_root(&txns.commit_txns),
-        reveal_hash_merkle_root: merkle_tree_root(&txns.reveal_txns),
-        tally_hash_merkle_root: merkle_tree_root(&txns.tally_txns),
-    };
-    block_header.merkle_roots = merkle_roots;
-}
-
 fn h(left: Hash, right: Hash) -> Hash {
     let left = match left {
         Hash::SHA256(x) => Sha256(x),
@@ -53,7 +26,7 @@ fn example_block(txns: BlockTransactions) -> Block {
         hash_prev_block: last_block_hash,
     };
     let mut block_header = BlockHeader::default();
-    build_merkle_tree(&mut block_header, &txns);
+    block_header.merkle_roots = BlockMerkleRoots::from_transactions(&txns);
     block_header.beacon = block_beacon;
 
     let block_sig = KeyedSignature::default();

node/src/actors/chain_manager/mod.rs

@@ -2958,7 +2958,7 @@ mod tests {
         vrf::BlockEligibilityClaim,
     };
     use witnet_protected::Protected;
-    use witnet_validations::validations::{block_reward, merkle_tree_root};
+    use witnet_validations::validations::block_reward;
 
     use secp256k1::{
         PublicKey as Secp256k1_PublicKey, Secp256k1, SecretKey as Secp256k1_SecretKey,
@@ -3380,18 +3380,6 @@ mod tests {
     static PRIV_KEY_1: [u8; 32] = [0xcd; 32];
     static PRIV_KEY_2: [u8; 32] = [0x43; 32];
 
-    fn build_merkle_tree(block_header: &mut BlockHeader, txns: &BlockTransactions) {
-        let merkle_roots = BlockMerkleRoots {
-            mint_hash: txns.mint.hash(),
-            vt_hash_merkle_root: merkle_tree_root(&txns.value_transfer_txns),
-            dr_hash_merkle_root: merkle_tree_root(&txns.data_request_txns),
-            commit_hash_merkle_root: merkle_tree_root(&txns.commit_txns),
-            reveal_hash_merkle_root: merkle_tree_root(&txns.reveal_txns),
-            tally_hash_merkle_root: merkle_tree_root(&txns.tally_txns),
-        };
-        block_header.merkle_roots = merkle_roots;
-    }
-
     fn sign_tx<H: Hashable>(mk: [u8; 32], tx: &H) -> KeyedSignature {
         let Hash::SHA256(data) = tx.hash();
 
@@ -3460,7 +3448,7 @@ mod tests {
         };
 
         let mut block_header = BlockHeader::default();
-        build_merkle_tree(&mut block_header, &txns);
+        block_header.merkle_roots = BlockMerkleRoots::from_transactions(&txns);
         block_header.beacon = block_beacon;
         block_header.proof = BlockEligibilityClaim::create(vrf, &secret_key, vrf_input).unwrap();
 

validations/src/tests/mod.rs

@@ -7655,7 +7655,7 @@ fn test_block_with_drpool_and_utxo_set<F: FnMut(&mut Block) -> bool>(
     };
 
     let mut block_header = BlockHeader::default();
-    build_merkle_tree(&mut block_header, &txns);
+    block_header.merkle_roots = BlockMerkleRoots::from_transactions(&txns);
     block_header.beacon = block_beacon;
     block_header.proof = BlockEligibilityClaim::create(vrf, &secret_key, vrf_input).unwrap();
 
@@ -7698,18 +7698,6 @@ fn test_block_with_drpool_and_utxo_set<F: FnMut(&mut Block) -> bool>(
     Ok(())
 }
 
-fn build_merkle_tree(block_header: &mut BlockHeader, txns: &BlockTransactions) {
-    let merkle_roots = BlockMerkleRoots {
-        mint_hash: txns.mint.hash(),
-        vt_hash_merkle_root: merkle_tree_root(&txns.value_transfer_txns),
-        dr_hash_merkle_root: merkle_tree_root(&txns.data_request_txns),
-        commit_hash_merkle_root: merkle_tree_root(&txns.commit_txns),
-        reveal_hash_merkle_root: merkle_tree_root(&txns.reveal_txns),
-        tally_hash_merkle_root: merkle_tree_root(&txns.tally_txns),
-    };
-    block_header.merkle_roots = merkle_roots;
-}
-
 ///////////////////////////////////////////////////////////////////////////////
 // Block tests: one block
 ///////////////////////////////////////////////////////////////////////////////
@@ -7942,7 +7930,7 @@ fn block_difficult_proof() {
     };
 
     let mut block_header = BlockHeader::default();
-    build_merkle_tree(&mut block_header, &txns);
+    block_header.merkle_roots = BlockMerkleRoots::from_transactions(&txns);
     block_header.beacon = block_beacon;
     block_header.proof = BlockEligibilityClaim::create(vrf, &secret_key, vrf_input).unwrap();
 
@@ -8163,7 +8151,7 @@ fn block_duplicated_commits() {
                 }],
             );
 
-            build_merkle_tree(&mut b.block_header, &b.txns);
+            b.block_header.merkle_roots = BlockMerkleRoots::from_transactions(&b.txns);
 
             true
         },
@@ -8271,7 +8259,7 @@ fn block_duplicated_reveals() {
                 }],
             );
 
-            build_merkle_tree(&mut b.block_header, &b.txns);
+            b.block_header.merkle_roots = BlockMerkleRoots::from_transactions(&b.txns);
 
             true
         },
@@ -8338,7 +8326,7 @@ fn block_duplicated_tallies() {
                 }],
             );
 
-            build_merkle_tree(&mut b.block_header, &b.txns);
+            b.block_header.merkle_roots = BlockMerkleRoots::from_transactions(&b.txns);
 
             true
         },
@@ -8395,7 +8383,7 @@ fn block_before_and_after_hard_fork() {
                 }],
             );
 
-            build_merkle_tree(&mut b.block_header, &b.txns);
+            b.block_header.merkle_roots = BlockMerkleRoots::from_transactions(&b.txns);
 
             true
         },
@@ -8418,7 +8406,7 @@ fn block_before_and_after_hard_fork() {
                 }],
             );
 
-            build_merkle_tree(&mut b.block_header, &b.txns);
+            b.block_header.merkle_roots = BlockMerkleRoots::from_transactions(&b.txns);
 
             true
         },
@@ -8643,7 +8631,7 @@ fn test_blocks_with_limits(
             hash_prev_block: last_block_hash,
         };
         let mut block_header = BlockHeader::default();
-        build_merkle_tree(&mut block_header, &txns);
+        block_header.merkle_roots = BlockMerkleRoots::from_transactions(&txns);
         block_header.beacon = block_beacon;
         block_header.proof = BlockEligibilityClaim::create(vrf, &secret_key, vrf_input).unwrap();
 
@@ -9422,7 +9410,7 @@ fn validate_block_transactions_uses_block_number_in_utxo_diff() {
         };
 
         let mut block_header = BlockHeader::default();
-        build_merkle_tree(&mut block_header, &txns);
+        block_header.merkle_roots = BlockMerkleRoots::from_transactions(&txns);
         block_header.beacon = block_beacon;
         block_header.proof = BlockEligibilityClaim::create(vrf, &secret_key, vrf_input).unwrap();
 
@@ -9585,7 +9573,7 @@ fn validate_commit_transactions_included_in_utxo_diff() {
         txns.commit_txns.push(c_tx);
 
         let mut block_header = BlockHeader::default();
-        build_merkle_tree(&mut block_header, &txns);
+        block_header.merkle_roots = BlockMerkleRoots::from_transactions(&txns);
         block_header.beacon = block_beacon;
         block_header.proof = BlockEligibilityClaim::create(vrf, &secret_key, vrf_input).unwrap();