feat: introduce basic vector and set collections to storage (#914)

Co-authored-by: Miraculous Owonubi <[email protected]>
calimero-network · Nov 4, 2024 · a687c2a · a687c2a
1 parent c291850
commit a687c2a
Show file tree

Hide file tree

Showing 14 changed files with 1,136 additions and 280 deletions.
diff --git a/apps/kv-store/src/lib.rs b/apps/kv-store/src/lib.rs
@@ -4,17 +4,16 @@ use std::collections::BTreeMap;
 
 use calimero_sdk::types::Error;
 use calimero_sdk::{app, env};
-use calimero_storage::address::Path;
+use calimero_storage::collections::UnorderedMap;
 use calimero_storage::entities::Element;
-use calimero_storage::types::Map;
 use calimero_storage::AtomicUnit;
 
 #[app::state(emits = for<'a> Event<'a>)]
 #[derive(AtomicUnit, Clone, Debug, PartialEq, PartialOrd)]
 #[root]
 #[type_id(1)]
 pub struct KvStore {
-    items: Map<String, String>,
+    items: UnorderedMap<String, String>,
     #[storage]
     storage: Element,
 }
@@ -32,7 +31,7 @@ impl KvStore {
     #[app::init]
     pub fn init() -> KvStore {
         KvStore {
-            items: Map::new(&Path::new("::items").unwrap()).unwrap(),
+            items: UnorderedMap::new().unwrap(),
             storage: Element::root(),
         }
     }
@@ -87,7 +86,7 @@ impl KvStore {
         self.get(key)?.ok_or_else(|| Error::msg("Key not found."))
     }
 
-    pub fn remove(&mut self, key: &str) -> Result<Option<String>, Error> {
+    pub fn remove(&mut self, key: &str) -> Result<bool, Error> {
         env::log(&format!("Removing key: {:?}", key));
 
         app::emit!(Event::Removed { key });

diff --git a/crates/storage-macros/tests/atomic_unit.rs b/crates/storage-macros/tests/atomic_unit.rs
@@ -48,7 +48,7 @@ impl Private {
         Self {
             public: String::new(),
             private: String::new(),
-            storage: Element::new(path),
+            storage: Element::new(path, None),
         }
     }
 }
@@ -68,7 +68,7 @@ impl Simple {
         Self {
             name: String::new(),
             value: 0,
-            storage: Element::new(path),
+            storage: Element::new(path, None),
         }
     }
 }
@@ -89,7 +89,7 @@ impl Skipped {
         Self {
             included: String::new(),
             skipped: String::new(),
-            storage: Element::new(path),
+            storage: Element::new(path, None),
         }
     }
 }
@@ -251,8 +251,8 @@ mod hashing {
 
         let mut hasher = Sha256::new();
         hasher.update(unit.id().as_bytes());
-        hasher.update(&to_vec(&unit.public).unwrap());
-        hasher.update(&to_vec(&unit.element().metadata()).unwrap());
+        hasher.update(to_vec(&unit.public).unwrap());
+        hasher.update(to_vec(&unit.element().metadata()).unwrap());
         let expected_hash: [u8; 32] = hasher.finalize().into();
 
         assert_eq!(unit.calculate_merkle_hash().unwrap(), expected_hash);
@@ -274,9 +274,9 @@ mod hashing {
 
         let mut hasher = Sha256::new();
         hasher.update(unit.id().as_bytes());
-        hasher.update(&to_vec(&unit.name).unwrap());
-        hasher.update(&to_vec(&unit.value).unwrap());
-        hasher.update(&to_vec(&unit.element().metadata()).unwrap());
+        hasher.update(to_vec(&unit.name).unwrap());
+        hasher.update(to_vec(&unit.value).unwrap());
+        hasher.update(to_vec(&unit.element().metadata()).unwrap());
         let expected_hash: [u8; 32] = hasher.finalize().into();
 
         assert_eq!(unit.calculate_merkle_hash().unwrap(), expected_hash);
@@ -294,8 +294,8 @@ mod hashing {
 
         let mut hasher = Sha256::new();
         hasher.update(unit.id().as_bytes());
-        hasher.update(&to_vec(&unit.included).unwrap());
-        hasher.update(&to_vec(&unit.element().metadata()).unwrap());
+        hasher.update(to_vec(&unit.included).unwrap());
+        hasher.update(to_vec(&unit.element().metadata()).unwrap());
         let expected_hash: [u8; 32] = hasher.finalize().into();
 
         assert_eq!(unit.calculate_merkle_hash().unwrap(), expected_hash);

diff --git a/crates/storage-macros/tests/collection.rs b/crates/storage-macros/tests/collection.rs
@@ -43,7 +43,7 @@ impl Child {
     fn new(path: &Path) -> Self {
         Self {
             content: String::new(),
-            storage: Element::new(path),
+            storage: Element::new(path, None),
         }
     }
 }
@@ -53,7 +53,7 @@ impl Child {
 struct Group;
 
 impl Group {
-    fn new() -> Self {
+    const fn new() -> Self {
         Self {}
     }
 }
@@ -74,7 +74,7 @@ impl Parent {
         Self {
             title: String::new(),
             children: Group::new(),
-            storage: Element::new(path),
+            storage: Element::new(path, None),
         }
     }
 }
@@ -94,7 +94,7 @@ impl Simple {
         Self {
             name: String::new(),
             value: 0,
-            storage: Element::new(path),
+            storage: Element::new(path, None),
         }
     }
 }
@@ -135,8 +135,8 @@ mod hashing {
 
         let mut hasher = Sha256::new();
         hasher.update(child.id().as_bytes());
-        hasher.update(&to_vec(&child.content).unwrap());
-        hasher.update(&to_vec(&child.element().metadata()).unwrap());
+        hasher.update(to_vec(&child.content).unwrap());
+        hasher.update(to_vec(&child.element().metadata()).unwrap());
         let expected_hash: [u8; 32] = hasher.finalize().into();
 
         assert_eq!(child.calculate_merkle_hash().unwrap(), expected_hash);
@@ -149,8 +149,8 @@ mod hashing {
 
         let mut hasher = Sha256::new();
         hasher.update(parent.id().as_bytes());
-        hasher.update(&to_vec(&parent.title).unwrap());
-        hasher.update(&to_vec(&parent.element().metadata()).unwrap());
+        hasher.update(to_vec(&parent.title).unwrap());
+        hasher.update(to_vec(&parent.element().metadata()).unwrap());
         let expected_hash: [u8; 32] = hasher.finalize().into();
 
         assert_eq!(parent.calculate_merkle_hash().unwrap(), expected_hash);

diff --git a/crates/storage-macros/tests/compile_fail/collection.rs b/crates/storage-macros/tests/compile_fail/collection.rs
@@ -27,7 +27,7 @@ fn main() {
     fn child_type_specification() {
         let parent: Parent = Parent {
             group: Group {},
-            storage: Element::new(&Path::new("::root::node").unwrap()),
+            storage: Element::new(&Path::new("::root::node").unwrap(), None),
         };
         let _: Vec<Child> = Interface::children_of(parent.id(), &parent.group).unwrap();
 

diff --git a/crates/storage/src/collections.rs b/crates/storage/src/collections.rs
@@ -0,0 +1,14 @@
+//! High-level data structures for storage.
+
+/// This module provides functionality for hashmap data structures.
+pub mod unordered_map;
+pub use unordered_map::UnorderedMap;
+/// This module provides functionality for hashset data structures.
+pub mod unordered_set;
+pub use unordered_set::UnorderedSet;
+/// This module provides functionality for vector data structures.
+pub mod vector;
+pub use vector::Vector;
+/// This module provides functionality for handling errors.
+pub mod error;
+pub use error::StoreError;
diff --git a/crates/storage/src/collections/error.rs b/crates/storage/src/collections/error.rs
@@ -0,0 +1,17 @@
+use thiserror::Error;
+
+// fixme! macro expects `calimero_storage` to be in deps
+use crate::address::PathError;
+use crate::interface::StorageError;
+
+/// General error type for storage operations while interacting with complex collections.
+#[derive(Debug, Error)]
+#[non_exhaustive]
+pub enum StoreError {
+    /// Error while interacting with storage.
+    #[error(transparent)]
+    StorageError(#[from] StorageError),
+    /// Error while interacting with a path.
+    #[error(transparent)]
+    PathError(#[from] PathError),
+}