refactor(hashing): move borsh hasher into tari_hashing crate (#6174)

sdbondi · web-flow · commit f64be85cbf0e · 2024-03-05T10:06:17.000+02:00
Description
---
Move common hashers and domains required to interact with base layer
into common crate

Motivation and Context
---
In L2 we have a a borsh hasher that duplicates the functionality of the
consensus hasher in tari_core.
This crate allows us to use a common hasher implementation without
depending on tari_core.

TransactionHashDomain is also used in L1 and L2 so was moved into the
common crate.

How Has This Been Tested?
---
CI

What process can a PR reviewer use to test or verify this change?
---
CI

&lt;!-- Checklist --&gt;
&lt;!-- 1. Is the title of your PR in the form that would make nice release
notes? The title, excluding the conventional commit
tag, will be included exactly as is in the CHANGELOG, so please think
about it carefully. --&gt;


Breaking Changes
---

- [x] None
- [ ] Requires data directory on base node to be deleted
- [ ] Requires hard fork
- [ ] Other - Please specify

&lt;!-- Does this include a breaking change? If so, include this line as a
footer --&gt;
&lt;!-- BREAKING CHANGE: Description what the user should do, e.g. delete a
database, resync the chain --&gt;
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -31,7 +31,7 @@ members = [
     "applications/minotari_merge_mining_proxy",
     "applications/minotari_miner",
     "integration_tests",
-    "hash_domains",
+    "hashing",
 ]
 
 # Add here until we move to edition=2021
diff --git a/applications/minotari_console_wallet/Cargo.toml b/applications/minotari_console_wallet/Cargo.toml
@@ -23,7 +23,7 @@ tari_utilities = { version = "0.7" }
 minotari_wallet = { path = "../../base_layer/wallet", features = [
   "bundled_sqlite",
 ] }
-tari_hash_domains = { path = "../../hash_domains" }
+tari_hashing = { path = "../../hashing" }
 
 # Uncomment for tokio tracing via tokio-console (needs "tracing" featurs)
 console-subscriber = "0.1.8"
diff --git a/applications/minotari_console_wallet/src/ui/components/register_template_tab.rs b/applications/minotari_console_wallet/src/ui/components/register_template_tab.rs
@@ -11,7 +11,7 @@ use regex::Regex;
 use reqwest::StatusCode;
 use tari_core::transactions::{tari_amount::MicroMinotari, transaction_components::TemplateType};
 use tari_crypto::hashing::DomainSeparation;
-use tari_hash_domains::TariEngineHashDomain;
+use tari_hashing::TariEngineHashDomain;
 use tari_utilities::hex::Hex;
 use tokio::{
     runtime::{Handle, Runtime},
diff --git a/applications/minotari_console_wallet/src/ui/state/tasks.rs b/applications/minotari_console_wallet/src/ui/state/tasks.rs
@@ -40,10 +40,10 @@ use tari_core::{
     transactions::{
         tari_amount::MicroMinotari,
         transaction_components::{BuildInfo, OutputFeatures, TemplateType},
-        TransactionHashDomain,
     },
 };
 use tari_crypto::{keys::PublicKey as PublicKeyTrait, ristretto::RistrettoPublicKey};
+use tari_hashing::TransactionHashDomain;
 use tari_key_manager::key_manager::KeyManager;
 use tari_utilities::{hex::Hex, ByteArray};
 use tokio::sync::{broadcast, watch};
diff --git a/base_layer/core/Cargo.toml b/base_layer/core/Cargo.toml
@@ -44,8 +44,8 @@ tari_utilities = { version = "0.7", features = ["borsh"] }
 tari_key_manager = { path = "../key_manager", features = [
   "key_manager_service",
 ], version = "1.0.0-pre.9" }
-tari_common_sqlite = { path = "../../common_sqlite", version = "1.0.0-pre.9" }
-tari_hash_domains = { path = "../../hash_domains", version = "1.0.0-pre.9" }
+tari_common_sqlite = { path = "../../common_sqlite" }
+tari_hashing = { path = "../../hashing" }
 
 async-trait = { version = "0.1.50" }
 bincode = "1.1.4"
diff --git a/base_layer/core/src/chain_storage/blockchain_database.rs b/base_layer/core/src/chain_storage/blockchain_database.rs
@@ -40,6 +40,7 @@ use tari_common_types::{
     chain_metadata::ChainMetadata,
     types::{BlockHash, Commitment, FixedHash, HashOutput, PublicKey, Signature},
 };
+use tari_hashing::TransactionHashDomain;
 use tari_mmr::{
     pruned_hashset::PrunedHashSet,
     sparse_merkle_tree::{DeleteResult, NodeKey, ValueHash},
@@ -89,10 +90,7 @@ use crate::{
         DomainSeparatedConsensusHasher,
     },
     proof_of_work::{monero_rx::MoneroPowData, PowAlgorithm, TargetDifficultyWindow},
-    transactions::{
-        transaction_components::{TransactionInput, TransactionKernel, TransactionOutput},
-        TransactionHashDomain,
-    },
+    transactions::transaction_components::{TransactionInput, TransactionKernel, TransactionOutput},
     validation::{
         helpers::calc_median_timestamp,
         CandidateBlockValidator,
diff --git a/base_layer/core/src/common/mod.rs b/base_layer/core/src/common/mod.rs
@@ -22,7 +22,7 @@
 
 use blake2::Blake2b;
 use digest::consts::U64;
-use tari_hash_domains::ConfidentialOutputHashDomain;
+use tari_hashing::ConfidentialOutputHashDomain;
 
 use crate::consensus::DomainSeparatedConsensusHasher;
 
diff --git a/base_layer/core/src/common/one_sided.rs b/base_layer/core/src/common/one_sided.rs
@@ -31,7 +31,7 @@ use tari_crypto::{
     hashing::{DomainSeparatedHash, DomainSeparatedHasher},
     keys::{PublicKey as PKtrait, SecretKey as SKtrait},
 };
-use tari_hash_domains::WalletOutputEncryptionKeysDomain;
+use tari_hashing::WalletOutputEncryptionKeysDomain;
 use tari_utilities::byte_array::ByteArrayError;
 
 hash_domain!(
diff --git a/base_layer/core/src/consensus/consensus_encoding.rs b/base_layer/core/src/consensus/consensus_encoding.rs
@@ -24,7 +24,7 @@ mod bytes;
 mod hashing;
 mod string;
 
-pub use hashing::{ConsensusHasher, DomainSeparatedConsensusHasher};
+pub use hashing::DomainSeparatedConsensusHasher;
 pub use string::MaxSizeString;
 
 pub use self::bytes::MaxSizeBytes;
diff --git a/base_layer/core/src/consensus/consensus_encoding/hashing.rs b/base_layer/core/src/consensus/consensus_encoding/hashing.rs
@@ -20,75 +20,37 @@
 //  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 //  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-use std::{io, io::Write, marker::PhantomData};
-
-use blake2::Blake2b;
 use borsh::BorshSerialize;
-use digest::{
-    consts::{U32, U64},
-    Digest,
-};
+use digest::Digest;
 use tari_common::configuration::Network;
-use tari_crypto::{hash_domain, hashing::DomainSeparation};
+use tari_crypto::hashing::DomainSeparation;
+use tari_hashing::DomainSeparatedBorshHasher;
 
 /// Domain separated consensus encoding hasher.
+/// This is a thin wrapper around the domain-separated Borsh hasher but adds the network byte in its constructor
+/// functions
 pub struct DomainSeparatedConsensusHasher<M, D> {
-    _m: PhantomData<M>,
-    _d: PhantomData<D>,
+    hasher: DomainSeparatedBorshHasher<M, D>,
 }
 
 impl<M: DomainSeparation, D: Digest> DomainSeparatedConsensusHasher<M, D>
 where D: Default
 {
-    #[allow(clippy::new_ret_no_self)]
-    pub fn new(label: &'static str) -> ConsensusHasher<D> {
+    pub fn new(label: &'static str) -> Self {
         Self::new_with_network(label, Network::get_current_or_user_setting_or_default())
     }
 
-    pub fn new_with_network(label: &'static str, network: Network) -> ConsensusHasher<D> {
-        let mut digest = D::default();
-        M::add_domain_separation_tag(&mut digest, &format!("{}.n{}", label, network.as_byte()));
-        ConsensusHasher::from_digest(digest)
-    }
-}
-
-#[derive(Clone)]
-pub struct ConsensusHasher<D> {
-    writer: WriteHashWrapper<D>,
-}
-
-impl<D: Digest> ConsensusHasher<D> {
-    fn from_digest(digest: D) -> Self {
-        Self {
-            writer: WriteHashWrapper(digest),
-        }
-    }
-}
-
-impl ConsensusHasher<Blake2b<U32>> {
-    pub fn finalize(self) -> [u8; 32] {
-        self.writer.0.finalize().into()
-    }
-
-    pub fn update_consensus_encode<T: BorshSerialize>(&mut self, data: &T) {
-        BorshSerialize::serialize(data, &mut self.writer)
-            .expect("Incorrect implementation of BorshSerialize encountered. Implementations MUST be infallible.");
-    }
-
-    pub fn chain<T: BorshSerialize>(mut self, data: &T) -> Self {
-        self.update_consensus_encode(data);
-        self
+    pub fn new_with_network(label: &'static str, network: Network) -> Self {
+        let hasher = DomainSeparatedBorshHasher::<M, D>::new_with_label(&format!("{}.n{}", label, network.as_byte()));
+        Self { hasher }
     }
-}
 
-impl ConsensusHasher<Blake2b<U64>> {
-    pub fn finalize(self) -> [u8; 64] {
-        self.writer.0.finalize().into()
+    pub fn finalize(self) -> digest::Output<D> {
+        self.hasher.finalize()
     }
 
     pub fn update_consensus_encode<T: BorshSerialize>(&mut self, data: &T) {
-        BorshSerialize::serialize(data, &mut self.writer)
-            .expect("Incorrect implementation of BorshSerialize encountered. Implementations MUST be infallible.");
+        self.hasher.update_consensus_encode(data);
     }
 
     pub fn chain<T: BorshSerialize>(mut self, data: &T) -> Self {
@@ -97,45 +59,11 @@ impl ConsensusHasher<Blake2b<U64>> {
     }
 }
 
-impl Default for ConsensusHasher<Blake2b<U32>> {
+impl<M: DomainSeparation, D: Digest + Default> Default for DomainSeparatedConsensusHasher<M, D> {
     /// This `default` implementation is provided for convenience, but should not be used as the de-facto consensus
-    /// hasher, rather create a new unique hash domain.
+    /// hasher, rather specify a specific label
     fn default() -> Self {
-        hash_domain!(
-            DefaultConsensusHashDomain,
-            "com.tari.base_layer.core.consensus.consensus_encoding.hashing",
-            0
-        );
-        DomainSeparatedConsensusHasher::<DefaultConsensusHashDomain, Blake2b<U32>>::new("default")
-    }
-}
-
-impl Default for ConsensusHasher<Blake2b<U64>> {
-    /// This `default` implementation is provided for convenience, but should not be used as the de-facto consensus
-    /// hasher, rather create a new unique hash domain.
-    fn default() -> Self {
-        hash_domain!(
-            DefaultConsensusHashDomain,
-            "com.tari.base_layer.core.consensus.consensus_encoding.hashing",
-            0
-        );
-        DomainSeparatedConsensusHasher::<DefaultConsensusHashDomain, Blake2b<U64>>::new("default")
-    }
-}
-
-/// This private struct wraps a Digest and implements the Write trait to satisfy the consensus encoding trait.
-/// Do not use the DomainSeparatedHasher with this.
-#[derive(Clone)]
-struct WriteHashWrapper<D>(D);
-
-impl<D: Digest> Write for WriteHashWrapper<D> {
-    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
-        self.0.update(buf);
-        Ok(buf.len())
-    }
-
-    fn flush(&mut self) -> io::Result<()> {
-        Ok(())
+        DomainSeparatedConsensusHasher::<M, D>::new("default")
     }
 }
 
@@ -185,7 +113,7 @@ mod tests {
             .chain(&255u64)
             .finalize();
 
-        assert_eq!(hash, expected_hash.as_ref());
+        assert_eq!(hash, expected_hash);
     }
 
     #[test]
@@ -202,15 +130,15 @@ mod tests {
             .chain(&test_subject)
             .finalize();
 
-        assert_eq!(hash, expected_hash.as_ref());
+        assert_eq!(hash, expected_hash);
     }
 
     #[test]
     fn default_consensus_hash_is_not_blake_default_hash() {
         let blake_hasher = Blake2b::<U32>::default();
         let blake_hash = blake_hasher.chain_update(b"").finalize();
 
-        let default_consensus_hasher = ConsensusHasher::<Blake2b<U32>>::default();
+        let default_consensus_hasher = DomainSeparatedConsensusHasher::<TestHashDomain, Blake2b<U32>>::default();
         let default_consensus_hash = default_consensus_hasher.chain(b"").finalize();
 
         assert_ne!(blake_hash.as_slice(), default_consensus_hash.as_slice());
diff --git a/base_layer/core/src/lib.rs b/base_layer/core/src/lib.rs
@@ -57,7 +57,7 @@ mod domain_hashing {
     use blake2::Blake2b;
     use digest::consts::U32;
     use tari_crypto::{hash_domain, hashing::DomainSeparatedHasher};
-    use tari_hash_domains::ValidatorNodeBmtHashDomain;
+    use tari_hashing::ValidatorNodeBmtHashDomain;
     use tari_mmr::{
         pruned_hashset::PrunedHashSet,
         sparse_merkle_tree::SparseMerkleTree,
diff --git a/base_layer/core/src/transactions/mod.rs b/base_layer/core/src/transactions/mod.rs
@@ -6,7 +6,6 @@ pub mod aggregated_body;
 mod crypto_factories;
 
 pub use crypto_factories::CryptoFactories;
-use tari_crypto::hash_domain;
 
 mod coinbase_builder;
 pub use coinbase_builder::{
@@ -33,7 +32,3 @@ pub mod key_manager;
 #[macro_use]
 #[cfg(feature = "base_node")]
 pub mod test_helpers;
-
-// Hash domain for all transaction-related hashes, including the script signature challenge, transaction hash and kernel
-// signature challenge
-hash_domain!(TransactionHashDomain, "com.tari.base_layer.core.transactions", 0);
diff --git a/base_layer/core/src/transactions/transaction_components/encrypted_data.rs b/base_layer/core/src/transactions/transaction_components/encrypted_data.rs
@@ -40,7 +40,7 @@ use digest::{consts::U32, generic_array::GenericArray, FixedOutput};
 use serde::{Deserialize, Serialize};
 use tari_common_types::types::{Commitment, PrivateKey};
 use tari_crypto::{hashing::DomainSeparatedHasher, keys::SecretKey};
-use tari_hash_domains::TransactionSecureNonceKdfDomain;
+use tari_hashing::TransactionSecureNonceKdfDomain;
 use tari_utilities::{
     hex::{from_hex, to_hex, Hex, HexError},
     safe_array::SafeArray,
diff --git a/base_layer/core/src/transactions/transaction_components/mod.rs b/base_layer/core/src/transactions/transaction_components/mod.rs
@@ -90,8 +90,10 @@ hidden_type!(EncryptedDataKey, SafeArray<u8, AEAD_KEY_LEN>);
 
 //----------------------------------------     Crate functions   ----------------------------------------------------//
 
+use tari_hashing::TransactionHashDomain;
+
 use super::tari_amount::MicroMinotari;
-use crate::{consensus::DomainSeparatedConsensusHasher, covenants::Covenant, transactions::TransactionHashDomain};
+use crate::{consensus::DomainSeparatedConsensusHasher, covenants::Covenant};
 
 /// Implement the canonical hashing function for TransactionOutput and WalletOutput for use in
 /// ordering as well as for the output hash calculation for TransactionInput.
diff --git a/base_layer/core/src/transactions/transaction_components/side_chain/validator_node_registration.rs b/base_layer/core/src/transactions/transaction_components/side_chain/validator_node_registration.rs
@@ -29,12 +29,10 @@ use tari_common_types::{
     epoch::VnEpoch,
     types::{FixedHash, PublicKey, Signature},
 };
+use tari_hashing::TransactionHashDomain;
 use tari_utilities::ByteArray;
 
-use crate::{
-    consensus::DomainSeparatedConsensusHasher,
-    transactions::{transaction_components::ValidatorNodeSignature, TransactionHashDomain},
-};
+use crate::{consensus::DomainSeparatedConsensusHasher, transactions::transaction_components::ValidatorNodeSignature};
 
 #[derive(Debug, Clone, Hash, PartialEq, Eq, Deserialize, Serialize, BorshSerialize, BorshDeserialize)]
 pub struct ValidatorNodeRegistration {
@@ -90,6 +88,7 @@ fn generate_shard_key(public_key: &PublicKey, entropy: &[u8; 32]) -> [u8; 32] {
         .chain(public_key)
         .chain(entropy)
         .finalize()
+        .into()
 }
 
 #[cfg(test)]
diff --git a/base_layer/core/src/transactions/transaction_components/transaction_input.rs b/base_layer/core/src/transactions/transaction_components/transaction_input.rs
@@ -35,6 +35,7 @@ use rand::rngs::OsRng;
 use serde::{Deserialize, Serialize};
 use tari_common_types::types::{ComAndPubSignature, Commitment, CommitmentFactory, FixedHash, HashOutput, PublicKey};
 use tari_crypto::tari_utilities::hex::Hex;
+use tari_hashing::TransactionHashDomain;
 use tari_script::{ExecutionStack, ScriptContext, StackItem, TariScript};
 
 use super::{TransactionInputVersion, TransactionOutputVersion};
@@ -50,7 +51,6 @@ use crate::{
             OutputFeatures,
             TransactionError,
         },
-        TransactionHashDomain,
     },
 };
 
@@ -209,6 +209,7 @@ impl TransactionInput {
                     .chain(commitment)
                     .chain(&message)
                     .finalize()
+                    .into()
             },
         }
     }
@@ -227,6 +228,7 @@ impl TransactionInput {
                     .chain(script)
                     .chain(input_data)
                     .finalize()
+                    .into()
             },
         }
     }
diff --git a/base_layer/core/src/transactions/transaction_components/transaction_kernel.rs b/base_layer/core/src/transactions/transaction_components/transaction_kernel.rs
diff --git a/base_layer/core/src/transactions/transaction_components/transaction_output.rs b/base_layer/core/src/transactions/transaction_components/transaction_output.rs
diff --git a/hashing/Cargo.toml b/hashing/Cargo.toml
diff --git a/hashing/README.md b/hashing/README.md
diff --git a/hashing/src/borsh_hasher.rs b/hashing/src/borsh_hasher.rs
diff --git a/hashing/src/domains.rs b/hashing/src/domains.rs
diff --git a/hashing/src/lib.rs b/hashing/src/lib.rs

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ members = [`
`31`	`31`	`"applications/minotari_merge_mining_proxy",`
`32`	`32`	`"applications/minotari_miner",`
`33`	`33`	`"integration_tests",`
`34`		`- "hash_domains",`
	`34`	`+ "hashing",`
`35`	`35`	`]`
`36`	`36`
`37`	`37`	`# Add here until we move to edition=2021`