rename HashedNodeStore::initialize to new; add comment

ava-labs · Jul 10, 2024 · 802f8ef · 802f8ef
1 parent 3155892
commit 802f8ef
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/firewood/benches/hashops.rs b/firewood/benches/hashops.rs
@@ -86,7 +86,7 @@ fn bench_merkle<const NKEYS: usize, const KEYSIZE: usize>(criterion: &mut Criter
             b.iter_batched(
                 || {
                     let store = MemStore::new(vec![]);
-                    let hns = HashedNodeStore::initialize(store).unwrap();
+                    let hns = HashedNodeStore::new(store).unwrap();
                     let merkle = Merkle::new(hns);
 
                     let keys: Vec<Vec<u8>> = repeat_with(|| {

diff --git a/firewood/src/hashednode.rs b/firewood/src/hashednode.rs
@@ -34,12 +34,13 @@ pub struct HashedNodeStore<T: ReadLinearStore> {
 }
 
 impl<T: WriteLinearStore> HashedNodeStore<T> {
-    pub fn initialize(linearstore: T) -> Result<Self, Error> {
+    /// Returns a new empty HashedNodeStore that uses `linearstore` as the backing store.
+    pub fn new(linearstore: T) -> Result<Self, Error> {
         let nodestore = NodeStore::initialize(linearstore)?;
         Ok(HashedNodeStore {
             nodestore,
             added: Default::default(),
-            root_hash: Default::default(),
+            root_hash: None,
         })
     }
 }
@@ -129,9 +130,8 @@ impl<T: WriteLinearStore> HashedNodeStore<T> {
             None
         };
         assert!(self.added.is_empty());
-        let frozen_nodestore = self.nodestore.freeze();
         Ok(HashedNodeStore {
-            nodestore: frozen_nodestore,
+            nodestore: self.nodestore.freeze(),
             added: Default::default(),
             root_hash,
         })
@@ -484,7 +484,7 @@ mod test {
     #[test]
     fn freeze_test() {
         let memstore = MemStore::new(vec![]);
-        let mut hns = HashedNodeStore::initialize(memstore).unwrap();
+        let mut hns = HashedNodeStore::new(memstore).unwrap();
         let node = Node::Leaf(storage::LeafNode {
             partial_path: Path(Default::default()),
             value: Box::new(*b"abc"),

diff --git a/firewood/src/merkle.rs b/firewood/src/merkle.rs
@@ -831,7 +831,7 @@ mod tests {
     }
 
     fn create_in_memory_merkle() -> Merkle<MemStore> {
-        Merkle::new(HashedNodeStore::initialize(MemStore::new(vec![])).unwrap())
+        Merkle::new(HashedNodeStore::new(MemStore::new(vec![])).unwrap())
     }
 
     // use super::*;
@@ -1411,7 +1411,7 @@ mod tests {
     fn merkle_build_test<K: AsRef<[u8]>, V: AsRef<[u8]>>(
         items: Vec<(K, V)>,
     ) -> Result<Merkle<MemStore>, MerkleError> {
-        let mut merkle = Merkle::new(HashedNodeStore::initialize(MemStore::new(vec![])).unwrap());
+        let mut merkle = Merkle::new(HashedNodeStore::new(MemStore::new(vec![])).unwrap());
         for (k, v) in items.iter() {
             merkle.insert(k.as_ref(), Box::from(v.as_ref()))?;
             println!("{}", merkle.dump()?);

diff --git a/firewood/src/stream.rs b/firewood/src/stream.rs
@@ -580,7 +580,7 @@ mod tests {
     }
 
     pub(super) fn create_test_merkle() -> Merkle<MemStore> {
-        Merkle::new(HashedNodeStore::initialize(MemStore::new(vec![])).unwrap())
+        Merkle::new(HashedNodeStore::new(MemStore::new(vec![])).unwrap())
     }
 
     #[test_case(&[]; "empty key")]