use btreemap everywhere in genesis and state updates

bin/saya/src/tests.rs

@@ -71,7 +71,7 @@ async fn test_program_input_from_program_output() -> anyhow::Result<()> {
         ],
         state_updates: StateUpdates {
             nonce_updates: {
-                let mut map = std::collections::HashMap::new();
+                let mut map = std::collections::BTreeMap::new();
                 map.insert(
                     ContractAddress::from(Felt::from_str("1111").unwrap()),
                     Felt::from_str("22222").unwrap(),
@@ -84,19 +84,20 @@ async fn test_program_input_from_program_output() -> anyhow::Result<()> {
             )]
             .into_iter()
             .collect(),
-            contract_updates: {
-                let mut map = std::collections::HashMap::new();
+            deployed_contracts: {
+                let mut map = std::collections::BTreeMap::new();
                 map.insert(
                     ContractAddress::from(Felt::from_str("66666").unwrap()),
                     Felt::from_str("7777").unwrap(),
                 );
                 map
             },
             declared_classes: {
-                let mut map = std::collections::HashMap::new();
+                let mut map = std::collections::BTreeMap::new();
                 map.insert(Felt::from_str("88888").unwrap(), Felt::from_str("99999").unwrap());
                 map
             },
+            ..Default::default()
         },
         world_da: None,
     };

crates/katana/controller/src/lib.rs

@@ -1,4 +1,4 @@
-use std::collections::HashMap;
+use std::collections::BTreeMap;
 
 use alloy_primitives::U256;
 use anyhow::Result;
@@ -131,7 +131,7 @@ pub mod json {
 fn get_contract_storage(
     credential_id: CredentialID,
     public_key: CoseKey,
-) -> Result<HashMap<StorageKey, StorageValue>> {
+) -> Result<BTreeMap<StorageKey, StorageValue>> {
     use slot::account_sdk::signers::DeviceError;
     use webauthn_rs_proto::auth::PublicKeyCredentialRequestOptions;
     use webauthn_rs_proto::{
@@ -186,7 +186,7 @@ fn get_contract_storage(
     let storage = get_storage_var_address(MULTIPLE_OWNERS_COMPONENT_SUB_STORAGE, &[guid])?;
 
     // 1 for boolean True in Cairo. Refer to the provided link above.
-    let storage_mapping = HashMap::from([(storage, Felt::ONE)]);
+    let storage_mapping = BTreeMap::from([(storage, Felt::ONE)]);
 
     Ok(storage_mapping)
 }

crates/katana/executor/src/implementation/blockifier/utils.rs

@@ -1,4 +1,4 @@
-use std::collections::{BTreeMap, HashMap};
+use std::collections::BTreeMap;
 use std::num::NonZeroU128;
 use std::sync::Arc;
 
@@ -403,12 +403,15 @@ pub(super) fn state_update_from_cached_state<S: StateDb>(
 
     let state_diff = state.0.lock().inner.to_state_diff().unwrap();
 
-    let mut declared_compiled_classes: HashMap<katana_primitives::class::ClassHash, CompiledClass> =
-        HashMap::new();
-    let mut declared_sierra_classes: HashMap<
+    let mut declared_compiled_classes: BTreeMap<
+        katana_primitives::class::ClassHash,
+        CompiledClass,
+    > = BTreeMap::new();
+
+    let mut declared_sierra_classes: BTreeMap<
         katana_primitives::class::ClassHash,
         FlattenedSierraClass,
-    > = HashMap::new();
+    > = BTreeMap::new();
 
     for class_hash in state_diff.compiled_class_hashes.keys() {
         let hash = class_hash.0;
@@ -427,27 +430,29 @@ pub(super) fn state_update_from_cached_state<S: StateDb>(
             .nonces
             .into_iter()
             .map(|(key, value)| (to_address(key), value.0))
-            .collect::<HashMap<
+            .collect::<BTreeMap<
                 katana_primitives::contract::ContractAddress,
                 katana_primitives::contract::Nonce,
             >>();
 
-    let storage_updates =
-        state_diff.storage.into_iter().fold(HashMap::new(), |mut storage, ((addr, key), value)| {
-            let entry: &mut HashMap<
+    let storage_updates = state_diff.storage.into_iter().fold(
+        BTreeMap::new(),
+        |mut storage, ((addr, key), value)| {
+            let entry: &mut BTreeMap<
                 katana_primitives::contract::StorageKey,
                 katana_primitives::contract::StorageValue,
             > = storage.entry(to_address(addr)).or_default();
             entry.insert(*key.0.key(), value);
             storage
-        });
+        },
+    );
 
-    let contract_updates =
+    let deployed_contracts =
         state_diff
             .class_hashes
             .into_iter()
             .map(|(key, value)| (to_address(key), value.0))
-            .collect::<HashMap<
+            .collect::<BTreeMap<
                 katana_primitives::contract::ContractAddress,
                 katana_primitives::class::ClassHash,
             >>();
@@ -457,7 +462,7 @@ pub(super) fn state_update_from_cached_state<S: StateDb>(
             .compiled_class_hashes
             .into_iter()
             .map(|(key, value)| (key.0, value.0))
-            .collect::<HashMap<
+            .collect::<BTreeMap<
                 katana_primitives::class::ClassHash,
                 katana_primitives::class::CompiledClassHash,
             >>();
@@ -468,8 +473,9 @@ pub(super) fn state_update_from_cached_state<S: StateDb>(
         state_updates: StateUpdates {
             nonce_updates,
             storage_updates,
-            contract_updates,
+            deployed_contracts,
             declared_classes,
+            ..Default::default()
         },
     }
 }
@@ -651,7 +657,7 @@ fn to_l2_l1_messages(
 #[cfg(test)]
 mod tests {
 
-    use std::collections::HashSet;
+    use std::collections::{HashMap, HashSet};
 
     use katana_cairo::cairo_vm::types::builtin_name::BuiltinName;
     use katana_cairo::cairo_vm::vm::runners::cairo_runner::ExecutionResources;

crates/katana/executor/tests/executor.rs

@@ -1,6 +1,6 @@
 mod fixtures;
 
-use std::collections::HashMap;
+use std::collections::BTreeMap;
 
 use fixtures::{state_provider, valid_blocks};
 use katana_executor::{ExecutionOutput, ExecutionResult, ExecutorFactory};
@@ -55,7 +55,11 @@ fn test_executor_with_valid_blocks_impl<EF: ExecutorFactory>(
 
     // ensure that all transactions succeeded, if not panic with the error message and tx index
     let has_failed = transactions.iter().enumerate().find_map(|(i, (_, res))| {
-        if let ExecutionResult::Failed { error } = res { Some((i, error)) } else { None }
+        if let ExecutionResult::Failed { error } = res {
+            Some((i, error))
+        } else {
+            None
+        }
     });
 
     if let Some((pos, error)) = has_failed {
@@ -283,16 +287,17 @@ fn test_executor_with_valid_blocks_impl<EF: ExecutorFactory>(
     assert_eq!(actual_txs, expected_txs);
 
     let actual_nonce_updates = states.state_updates.nonce_updates;
-    let expected_nonce_updates = HashMap::from([(main_account, felt!("3")), (new_acc, felt!("1"))]);
+    let expected_nonce_updates =
+        BTreeMap::from([(main_account, felt!("3")), (new_acc, felt!("1"))]);
 
     let actual_declared_classes = states.state_updates.declared_classes;
-    let expected_declared_classes = HashMap::from([(
+    let expected_declared_classes = BTreeMap::from([(
         felt!("0x420"),
         felt!("0x016c6081eb34ad1e0c5513234ed0c025b3c7f305902d291bad534cd6474c85bc"),
     )]);
 
-    let actual_contract_deployed = states.state_updates.contract_updates;
-    let expected_contract_deployed = HashMap::from([
+    let actual_contract_deployed = states.state_updates.deployed_contracts;
+    let expected_contract_deployed = BTreeMap::from([
         (new_acc, DEFAULT_OZ_ACCOUNT_CONTRACT_CLASS_HASH),
         (deployed_contract.into(), DEFAULT_LEGACY_ERC20_CONTRACT_CLASS_HASH),
     ]);

crates/katana/executor/tests/simulate.rs

@@ -71,7 +71,7 @@ fn test_simulate_tx_impl<EF: ExecutorFactory>(
 
     assert!(states.state_updates.nonce_updates.is_empty(), "no state updates");
     assert!(states.state_updates.storage_updates.is_empty(), "no state updates");
-    assert!(states.state_updates.contract_updates.is_empty(), "no state updates");
+    assert!(states.state_updates.deployed_contracts.is_empty(), "no state updates");
     assert!(states.state_updates.declared_classes.is_empty(), "no state updates");
 
     assert!(states.declared_sierra_classes.is_empty(), "no new classes should be declared");

crates/katana/primitives/Cargo.toml

@@ -25,8 +25,8 @@ flate2 = { workspace = true, optional = true }
 katana-cairo.workspace = true
 
 [dev-dependencies]
-assert_matches.workspace = true
 num-traits.workspace = true
+assert_matches.workspace = true
 similar-asserts.workspace = true
 
 [features]

crates/katana/primitives/src/genesis/allocation.rs

@@ -1,4 +1,4 @@
-use std::collections::HashMap;
+use std::collections::{BTreeMap, HashMap};
 use std::fmt::Debug;
 
 use alloy_primitives::U256;
@@ -59,7 +59,7 @@ impl GenesisAllocation {
     }
 
     /// Get the storage values for this contract allocation.
-    pub fn storage(&self) -> Option<&HashMap<StorageKey, StorageValue>> {
+    pub fn storage(&self) -> Option<&BTreeMap<StorageKey, StorageValue>> {
         match self {
             Self::Contract(contract) => contract.storage.as_ref(),
             Self::Account(account) => account.storage(),
@@ -107,7 +107,7 @@ impl GenesisAccountAlloc {
         }
     }
 
-    pub fn storage(&self) -> Option<&HashMap<StorageKey, StorageValue>> {
+    pub fn storage(&self) -> Option<&BTreeMap<StorageKey, StorageValue>> {
         match self {
             Self::Account(account) => account.storage.as_ref(),
             Self::DevAccount(account) => account.storage.as_ref(),
@@ -136,7 +136,7 @@ pub struct GenesisContractAlloc {
     pub nonce: Option<Felt>,
     /// The initial storage values of the contract.
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub storage: Option<HashMap<StorageKey, StorageValue>>,
+    pub storage: Option<BTreeMap<StorageKey, StorageValue>>,
 }
 
 /// Used mainly for development purposes where the account info including the
@@ -191,7 +191,7 @@ pub struct GenesisAccount {
     pub nonce: Option<Felt>,
     /// The initial storage values of the account.
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub storage: Option<HashMap<StorageKey, StorageValue>>,
+    pub storage: Option<BTreeMap<StorageKey, StorageValue>>,
 }
 
 impl GenesisAccount {