chore: remove needless TriePath type and use TrieHash everywhere. Also, add MARF::get_by_path() to look up MARFValues by TrieHash instead of by &str keys, and add the relevant ClarityBackingStore implementation to the stackslib's read-only and writeable MARF stores

Author: jcnelson

stacks-common/src/types/chainstate.rs

@@ -30,6 +30,68 @@ impl_byte_array_serde!(TrieHash);
 
 pub const TRIEHASH_ENCODED_SIZE: usize = 32;
 
+impl TrieHash {
+    pub fn from_key(k: &str) -> Self {
+        Self::from_data(k.as_bytes())
+    }
+
+    /// TrieHash of zero bytes
+    pub fn from_empty_data() -> TrieHash {
+        // sha2-512/256 hash of empty string.
+        // this is used so frequently it helps performance if we just have a constant for it.
+        TrieHash([
+            0xc6, 0x72, 0xb8, 0xd1, 0xef, 0x56, 0xed, 0x28, 0xab, 0x87, 0xc3, 0x62, 0x2c, 0x51,
+            0x14, 0x06, 0x9b, 0xdd, 0x3a, 0xd7, 0xb8, 0xf9, 0x73, 0x74, 0x98, 0xd0, 0xc0, 0x1e,
+            0xce, 0xf0, 0x96, 0x7a,
+        ])
+    }
+
+    /// TrieHash from bytes
+    pub fn from_data(data: &[u8]) -> TrieHash {
+        if data.len() == 0 {
+            return TrieHash::from_empty_data();
+        }
+
+        let mut tmp = [0u8; 32];
+
+        let mut hasher = Sha512_256::new();
+        hasher.update(data);
+        tmp.copy_from_slice(hasher.finalize().as_slice());
+
+        TrieHash(tmp)
+    }
+
+    pub fn from_data_array<B: AsRef<[u8]>>(data: &[B]) -> TrieHash {
+        if data.len() == 0 {
+            return TrieHash::from_empty_data();
+        }
+
+        let mut tmp = [0u8; 32];
+
+        let mut hasher = Sha512_256::new();
+
+        for item in data.iter() {
+            hasher.update(item);
+        }
+        tmp.copy_from_slice(hasher.finalize().as_slice());
+        TrieHash(tmp)
+    }
+
+    /// Convert to a String that can be used in e.g. sqlite
+    pub fn to_string(&self) -> String {
+        let s = format!("{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}",
+                          self.0[0],     self.0[1],       self.0[2],       self.0[3],
+                          self.0[4],     self.0[5],       self.0[6],       self.0[7],
+                          self.0[8],     self.0[9],       self.0[10],      self.0[11],
+                          self.0[12],    self.0[13],      self.0[14],      self.0[15],
+                          self.0[16],    self.0[17],      self.0[18],      self.0[19],
+                          self.0[20],    self.0[21],      self.0[22],      self.0[23],
+                          self.0[24],    self.0[25],      self.0[26],      self.0[27],
+                          self.0[28],    self.0[29],      self.0[30],      self.0[31]);
+        s
+    }
+}
+
 #[derive(Serialize, Deserialize)]
 pub struct BurnchainHeaderHash(pub [u8; 32]);
 impl_array_newtype!(BurnchainHeaderHash, u8, 32);

stackslib/src/burnchains/tests/burnchain.rs

@@ -44,7 +44,6 @@ use crate::chainstate::burn::{
     BlockSnapshot, ConsensusHash, ConsensusHashExtensions, OpsHash, SortitionHash,
 };
 use crate::chainstate::stacks::address::StacksAddressExtensions;
-use crate::chainstate::stacks::index::TrieHashExtension;
 use crate::chainstate::stacks::StacksPublicKey;
 use crate::util_lib::db::Error as db_error;
 

stackslib/src/chainstate/burn/db/processing.rs

@@ -353,7 +353,6 @@ mod tests {
     use crate::chainstate::burn::operations::{LeaderBlockCommitOp, LeaderKeyRegisterOp};
     use crate::chainstate::burn::*;
     use crate::chainstate::stacks::address::StacksAddressExtensions;
-    use crate::chainstate::stacks::index::TrieHashExtension;
     use crate::chainstate::stacks::StacksPublicKey;
     use crate::core::MICROSTACKS_PER_STACKS;
 

stackslib/src/chainstate/burn/db/sortdb.rs

@@ -6594,7 +6594,6 @@ pub mod tests {
         BlockstackOperationType, LeaderBlockCommitOp, LeaderKeyRegisterOp,
     };
     use crate::chainstate::burn::ConsensusHash;
-    use crate::chainstate::stacks::index::TrieHashExtension;
     use crate::chainstate::stacks::StacksPublicKey;
     use crate::core::{StacksEpochExtension, *};
     use crate::util_lib::db::Error as db_error;

stackslib/src/chainstate/burn/distribution.rs

@@ -450,7 +450,6 @@ mod tests {
     };
     use crate::chainstate::burn::ConsensusHash;
     use crate::chainstate::stacks::address::StacksAddressExtensions;
-    use crate::chainstate::stacks::index::TrieHashExtension;
     use crate::chainstate::stacks::StacksPublicKey;
     use crate::core::MINING_COMMITMENT_WINDOW;
 

stackslib/src/chainstate/burn/mod.rs

@@ -432,7 +432,6 @@ mod tests {
     use crate::burnchains::bitcoin::address::BitcoinAddress;
     use crate::burnchains::bitcoin::keys::BitcoinPublicKey;
     use crate::chainstate::burn::db::sortdb::*;
-    use crate::chainstate::stacks::index::TrieHashExtension;
     use crate::util_lib::db::Error as db_error;
 
     #[test]

stackslib/src/chainstate/burn/operations/leader_block_commit.rs

@@ -1172,7 +1172,6 @@ mod tests {
     use crate::chainstate::burn::operations::*;
     use crate::chainstate::burn::{ConsensusHash, *};
     use crate::chainstate::stacks::address::StacksAddressExtensions;
-    use crate::chainstate::stacks::index::TrieHashExtension;
     use crate::chainstate::stacks::StacksPublicKey;
     use crate::core::{
         StacksEpoch, StacksEpochExtension, StacksEpochId, PEER_VERSION_EPOCH_1_0,

stackslib/src/chainstate/burn/operations/leader_key_register.rs

@@ -253,7 +253,6 @@ pub mod tests {
     };
     use crate::chainstate::burn::{BlockSnapshot, ConsensusHash, OpsHash, SortitionHash};
     use crate::chainstate::stacks::address::StacksAddressExtensions;
-    use crate::chainstate::stacks::index::TrieHashExtension;
     use crate::core::StacksEpochId;
 
     pub struct OpFixture {

stackslib/src/chainstate/burn/sortition.rs

@@ -40,7 +40,7 @@ use crate::chainstate::burn::{
     SortitionHash,
 };
 use crate::chainstate::stacks::db::StacksChainState;
-use crate::chainstate::stacks::index::{ClarityMarfTrieId, MarfTrieId, TrieHashExtension};
+use crate::chainstate::stacks::index::{ClarityMarfTrieId, MarfTrieId};
 use crate::core::*;
 use crate::util_lib::db::Error as db_error;
 

stackslib/src/chainstate/stacks/index/bits.rs

@@ -29,7 +29,7 @@ use stacks_common::util::macros::is_trace;
 
 use crate::chainstate::stacks::index::node::{
     clear_backptr, ConsensusSerializable, TrieNode, TrieNode16, TrieNode256, TrieNode4, TrieNode48,
-    TrieNodeID, TrieNodeType, TriePtr, TRIEPATH_MAX_LEN, TRIEPTR_SIZE,
+    TrieNodeID, TrieNodeType, TriePtr, TRIEPTR_SIZE,
 };
 use crate::chainstate::stacks::index::storage::{TrieFileStorage, TrieStorageConnection};
 use crate::chainstate::stacks::index::{BlockMap, Error, MarfTrieId, TrieLeaf};
@@ -55,15 +55,15 @@ pub fn path_from_bytes<R: Read>(r: &mut R) -> Result<Vec<u8>, Error> {
         }
     })?;
 
-    if lenbuf[0] as usize > TRIEPATH_MAX_LEN {
+    if lenbuf[0] as usize > TRIEHASH_ENCODED_SIZE {
         trace!(
             "Path length is {} (expected <= {})",
             lenbuf[0],
-            TRIEPATH_MAX_LEN
+            TRIEHASH_ENCODED_SIZE
         );
         return Err(Error::CorruptionError(format!(
             "Node path is longer than {} bytes (got {})",
-            TRIEPATH_MAX_LEN, lenbuf[0]
+            TRIEHASH_ENCODED_SIZE, lenbuf[0]
         )));
     }
 
@@ -326,7 +326,7 @@ pub fn read_nodetype_at_head_nohash<F: Read + Seek>(
 ///   node hash      id  ptrs & ptr data      path
 ///
 /// X is fixed and determined by the TrieNodeType variant.
-/// Y is variable, but no more than TriePath::len().
+/// Y is variable, but no more than TrieHash::len().
 ///
 /// If `read_hash` is false, then the contents of the node hash are undefined.
 fn inner_read_nodetype_at_head<F: Read + Seek>(