chore: add deserialization types and basic casting implementation

Author: nimrod-starkware

Cargo.lock

@@ -14,6 +14,11 @@ license-file = "LICENSE"
 
 [workspace.dependencies]
 pretty_assertions = "1.2.1"
+serde = { version = "1.0.197", features = ["derive"] }
+serde_json = "1.0"
+starknet-types-core = "0.0.11"
+thiserror = "1.0.24"
+
 
 [workspace.lints.rust]
 warnings = "deny"

Cargo.toml

@@ -13,5 +13,7 @@ workspace = true
 pretty_assertions.workspace = true
 
 [dependencies]
-starknet-types-core = "0.0.11"
-starknet_api = "0.12.0-dev.0"
+serde.workspace = true
+serde_json.workspace = true
+starknet-types-core.workspace = true
+thiserror.workspace = true

crates/committer/Cargo.toml

@@ -0,0 +1,3 @@
+pub mod cast;
+pub mod errors;
+pub mod types;

crates/committer/src/deserialization.rs

@@ -0,0 +1,125 @@
+use super::errors::DeserializationError;
+use super::types::{Input, RawInput, StarknetStorageKey, StarknetStorageValue, StateDiff};
+use crate::deserialization::types::{ContractAddress, ContractState, StorageKey, StorageValue};
+use crate::hash::types::HashOutput;
+use crate::patricia_merkle_tree::filled_node::{ClassHash, Nonce};
+use crate::types::Felt;
+use std::collections::HashMap;
+
+impl TryFrom<RawInput> for Input {
+    type Error = DeserializationError;
+    fn try_from(raw_input: RawInput) -> Result<Self, Self::Error> {
+        let mut storage = HashMap::new();
+        for entry in raw_input.storage {
+            if storage
+                .insert(StorageKey(entry.key), StorageValue(entry.value))
+                .is_some()
+            {
+                return Err(DeserializationError::Duplicate("storage".to_string()));
+            }
+        }
+
+        let mut address_to_class_hash = HashMap::new();
+        for entry in raw_input.state_diff.address_to_class_hash {
+            if address_to_class_hash
+                .insert(
+                    ContractAddress(Felt::from_bytes_be_slice(&entry.key)),
+                    ClassHash(Felt::from_bytes_be_slice(&entry.value)),
+                )
+                .is_some()
+            {
+                return Err(DeserializationError::Duplicate(
+                    "address to class hash".to_string(),
+                ));
+            }
+        }
+
+        let mut address_to_nonce = HashMap::new();
+        for entry in raw_input.state_diff.address_to_nonce {
+            if address_to_nonce
+                .insert(
+                    ContractAddress(Felt::from_bytes_be_slice(&entry.key)),
+                    Nonce(Felt::from_bytes_be_slice(&entry.value)),
+                )
+                .is_some()
+            {
+                return Err(DeserializationError::Duplicate(
+                    "address to nonce".to_string(),
+                ));
+            }
+        }
+
+        let mut class_hash_to_compiled_class_hash = HashMap::new();
+        for entry in raw_input.state_diff.class_hash_to_compiled_class_hash {
+            if class_hash_to_compiled_class_hash
+                .insert(
+                    ClassHash(Felt::from_bytes_be_slice(&entry.key)),
+                    ClassHash(Felt::from_bytes_be_slice(&entry.value)),
+                )
+                .is_some()
+            {
+                return Err(DeserializationError::Duplicate(
+                    "class hash to compiled class hash".to_string(),
+                ));
+            }
+        }
+
+        let mut current_contract_state_leaves = HashMap::new();
+        for entry in raw_input.state_diff.current_contract_state_leaves {
+            if current_contract_state_leaves
+                .insert(
+                    ContractAddress(Felt::from_bytes_be_slice(&entry.address)),
+                    ContractState {
+                        nonce: Nonce(Felt::from_bytes_be_slice(&entry.nonce)),
+                        class_hash: ClassHash(Felt::from_bytes_be_slice(&entry.class_hash)),
+                        storage_root_hash: HashOutput(Felt::from_bytes_be_slice(
+                            &entry.storage_root_hash,
+                        )),
+                    },
+                )
+                .is_some()
+            {
+                return Err(DeserializationError::Duplicate(
+                    "current contract state leaves".to_string(),
+                ));
+            }
+        }
+
+        let mut storage_updates = HashMap::new();
+        for outer_entry in raw_input.state_diff.storage_updates {
+            let inner_map = outer_entry
+                .storage_updates
+                .iter()
+                .map(|inner_entry| {
+                    (
+                        StarknetStorageKey(Felt::from_bytes_be_slice(&inner_entry.key)),
+                        StarknetStorageValue(Felt::from_bytes_be_slice(&inner_entry.value)),
+                    )
+                })
+                .collect();
+            if storage_updates
+                .insert(
+                    ContractAddress(Felt::from_bytes_be_slice(&outer_entry.address)),
+                    inner_map,
+                )
+                .is_some()
+            {
+                return Err(DeserializationError::Duplicate(
+                    "starknet storage updates".to_string(),
+                ));
+            }
+        }
+
+        Ok(Input {
+            storage,
+            state_diff: StateDiff {
+                address_to_class_hash,
+                address_to_nonce,
+                class_hash_to_compiled_class_hash,
+                current_contract_state_leaves,
+                storage_updates,
+            },
+            tree_height: raw_input.tree_height,
+        })
+    }
+}

crates/committer/src/deserialization/cast.rs

@@ -0,0 +1,8 @@
+use thiserror::Error;
+
+#[allow(dead_code)]
+#[derive(Debug, Error)]
+pub(crate) enum DeserializationError {
+    #[error("There is a key duplication at {0} mapping.")]
+    Duplicate(String),
+}

crates/committer/src/deserialization/errors.rs

@@ -0,0 +1,109 @@
+use crate::{
+    hash::types::HashOutput,
+    patricia_merkle_tree::filled_node::{ClassHash, Nonce},
+    types::Felt,
+};
+use serde::Deserialize;
+use std::collections::HashMap;
+
+type RawFelt = [u8; 32];
+#[derive(PartialEq, Eq, Hash)]
+pub(crate) struct StorageKey(pub Vec<u8>);
+#[allow(dead_code)]
+pub(crate) struct StorageValue(pub Vec<u8>);
+#[derive(PartialEq, Eq, Hash)]
+// TODO(Nimrod, 1/6/2024): Swap to starknet-types-core types once implemented.
+pub(crate) struct ContractAddress(pub Felt);
+#[derive(PartialEq, Eq, Hash)]
+// TODO(Nimrod, 1/6/2024): Swap to starknet-types-core types once implemented.
+pub(crate) struct StarknetStorageKey(pub Felt);
+#[allow(dead_code)]
+pub(crate) struct StarknetStorageValue(pub Felt);
+
+#[derive(Deserialize, Debug)]
+#[allow(dead_code)]
+/// Input to the committer.
+pub(crate) struct RawInput {
+    /// Storage. Will be casted to HashMap<Bytes, Bytes> to simulate DB access.
+    pub storage: Vec<RawStorageEntry>,
+    /// All relevant information for the state diff commitment.
+    pub state_diff: RawStateDiff,
+    /// The height of the patricia tree.
+    // TODO(Nimrod,20/4/2024): Strong assumption - all trees have same height. How can I get
+    // rid of it?
+    pub tree_height: u8,
+}
+
+#[allow(dead_code)]
+pub(crate) struct Input {
+    pub storage: HashMap<StorageKey, StorageValue>,
+    pub state_diff: StateDiff,
+    pub tree_height: u8,
+}
+
+#[derive(Deserialize, Debug)]
+#[allow(dead_code)]
+/// Fact storage entry.
+pub(crate) struct RawStorageEntry {
+    pub key: Vec<u8>,
+    pub value: Vec<u8>,
+}
+
+#[derive(Deserialize, Debug)]
+#[allow(dead_code)]
+pub(crate) struct RawFeltMapEntry {
+    pub key: RawFelt,
+    pub value: RawFelt,
+}
+
+#[derive(Deserialize, Debug)]
+#[allow(dead_code)]
+/// Represents storage updates. Later will be casted to HashMap<Felt, HashMap<Felt,Felt>> entry.
+pub(crate) struct RawStorageUpdates {
+    pub address: RawFelt,
+    pub storage_updates: Vec<RawFeltMapEntry>,
+}
+
+#[derive(Deserialize, Debug)]
+#[allow(dead_code)]
+/// Represents current state leaf at the contract state tree. Later will be casted to
+/// HashMap<Felt, (nonce, class_hash, storage_root_hash)> entry.
+pub(crate) struct RawContractStateLeaf {
+    pub address: RawFelt,
+    pub nonce: RawFelt,
+    pub storage_root_hash: RawFelt,
+    pub class_hash: RawFelt,
+}
+
+#[derive(Deserialize, Debug)]
+#[allow(dead_code)]
+/// Represents state diff.
+pub(crate) struct RawStateDiff {
+    /// Will be casted to HashMap<Felt,Felt>.
+    pub address_to_class_hash: Vec<RawFeltMapEntry>,
+    /// Will be casted to HashMap<Felt,Felt>.
+    pub address_to_nonce: Vec<RawFeltMapEntry>,
+    /// Will be casted to HashMap<Felt,Felt>.
+    pub class_hash_to_compiled_class_hash: Vec<RawFeltMapEntry>,
+    /// Will be casted to HashMap<Felt,HashMap<Felt,Felt>>.
+    pub storage_updates: Vec<RawStorageUpdates>,
+    /// Will be casted to HashMap<Felt,ContractState>.
+    pub current_contract_state_leaves: Vec<RawContractStateLeaf>,
+}
+
+#[allow(dead_code)]
+pub(crate) struct StateDiff {
+    pub address_to_class_hash: HashMap<ContractAddress, ClassHash>,
+    pub address_to_nonce: HashMap<ContractAddress, Nonce>,
+    pub class_hash_to_compiled_class_hash: HashMap<ClassHash, ClassHash>,
+    pub current_contract_state_leaves: HashMap<ContractAddress, ContractState>,
+    pub storage_updates:
+        HashMap<ContractAddress, HashMap<StarknetStorageKey, StarknetStorageValue>>,
+}
+
+#[allow(dead_code)]
+pub(crate) struct ContractState {
+    pub nonce: Nonce,
+    pub class_hash: ClassHash,
+    pub storage_root_hash: HashOutput,
+}

crates/committer/src/deserialization/types.rs

@@ -1,3 +1,4 @@
+pub mod deserialization;
 pub mod hash;
 pub mod patricia_merkle_tree;
 pub mod types;

crates/committer/src/lib.rs

@@ -2,6 +2,7 @@ use crate::patricia_merkle_tree::types::{EdgeData, LeafDataTrait};
 use crate::{hash::types::HashOutput, types::Felt};
 // TODO(Nimrod, 1/6/2024): Swap to starknet-types-core types once implemented.
 #[allow(dead_code)]
+#[derive(Eq, PartialEq, Hash)]
 pub(crate) struct ClassHash(pub Felt);
 #[allow(dead_code)]
 pub(crate) struct Nonce(pub Felt);

crates/committer/src/patricia_merkle_tree/filled_node.rs

@@ -9,6 +9,7 @@ pub(crate) trait TreeHashFunction<L: LeafDataTrait, H: HashFunction> {
 
 // TODO(Amos, 01/05/2024): Implement types for NodeIndex, EdgePath, EdgePathLength
 #[allow(dead_code)]
+#[derive(Eq, PartialEq, Hash)]
 pub(crate) struct NodeIndex(pub Felt);
 
 #[allow(dead_code)]