Pin cache version to the forge version (#3039)

<!-- Reference any GitHub issues resolved by this PR -->

Closes #3021

## Introduced changes

<!-- A brief description of the changes -->

-

## Checklist

<!-- Make sure all of these are complete -->

- [x] Linked relevant issue
- [x] Updated relevant documentation
- [x] Added relevant tests
- [x] Performed self-review of the code
- [x] Added changes to `CHANGELOG.md`

---------

Co-authored-by: Artur Michałek <[email protected]>

Author: kkawula

CHANGELOG.md

@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Forge
 
+#### Changed
+
+- Fork cache version is pinned to the forge version.
+
 #### Fixed
 
 - `snforge_scarb_plugin` now emits an error when parameters are passed without using the `#[fuzzer]` attribute

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "cheatnet"
-version = "1.0.0"
+version.workspace = true
 edition.workspace = true
 
 [features]

crates/cheatnet/Cargo.toml

@@ -13,13 +13,17 @@ use std::collections::HashMap;
 use std::fs;
 use std::fs::OpenOptions;
 use std::io::{Read, Write};
+use std::string::ToString;
 use url::Url;
 
-pub const CACHE_VERSION: usize = 3;
+#[must_use]
+pub fn cache_version() -> String {
+    env!("CARGO_PKG_VERSION").replace('.', "_")
+}
 
 #[derive(Serialize, Deserialize, Debug)]
 struct ForkCacheContent {
-    cache_version: usize,
+    cache_version: String,
     storage_at: HashMap<ContractAddress, HashMap<StorageKey, Felt>>,
     nonce_at: HashMap<ContractAddress, Nonce>,
     class_hash_at: HashMap<ContractAddress, ClassHash>,
@@ -30,7 +34,7 @@ struct ForkCacheContent {
 impl Default for ForkCacheContent {
     fn default() -> Self {
         Self {
-            cache_version: CACHE_VERSION,
+            cache_version: cache_version(),
             storage_at: HashMap::default(),
             nonce_at: HashMap::default(),
             class_hash_at: HashMap::default(),
@@ -45,9 +49,11 @@ impl ForkCacheContent {
         let cache: Self =
             serde_json::from_str(serialized).expect("Could not deserialize cache from json");
 
-        assert!(
-            cache.cache_version == CACHE_VERSION,
-            "Expected the Version {CACHE_VERSION}"
+        assert_eq!(
+            cache.cache_version,
+            cache_version(),
+            "Expected the Version {}",
+            cache_version()
         );
 
         cache
@@ -247,7 +253,8 @@ fn cache_file_path_from_fork_config(
     let sanitized_path = re.replace_all(url.as_str(), "_");
 
     let cache_file_path = cache_dir.join(format!(
-        "{sanitized_path}_{block_number}_v{CACHE_VERSION}.json"
+        "{sanitized_path}_{block_number}_v{}.json",
+        cache_version()
     ));
 
     fs::create_dir_all(cache_file_path.parent().unwrap())

crates/cheatnet/src/forking/cache.rs

@@ -6,7 +6,8 @@ use blockifier::state::cached_state::CachedState;
 use cairo_vm::vm::errors::hint_errors::HintError;
 use camino::Utf8Path;
 use cheatnet::constants::build_testing_state;
-use cheatnet::forking::{cache::CACHE_VERSION, state::ForkStateReader};
+use cheatnet::forking::cache::cache_version;
+use cheatnet::forking::state::ForkStateReader;
 use cheatnet::runtime_extensions::forge_runtime_extension::cheatcodes::CheatcodeError;
 use cheatnet::state::{BlockInfoReader, CheatnetState, ExtendedStateReader};
 use conversions::IntoConv;
@@ -407,7 +408,7 @@ async fn using_specified_block_nb_is_cached() {
         let cache = read_cache(
             cache_dir
                 .path()
-                .join(format!("*v{CACHE_VERSION}.json"))
+                .join(format!("*v{}.json", cache_version()))
                 .to_str()
                 .unwrap(),
         );
@@ -487,7 +488,7 @@ async fn test_cache_merging() {
         let cache = read_cache(
             cache_dir
                 .path()
-                .join(format!("*v{CACHE_VERSION}.json"))
+                .join(format!("*v{}.json", cache_version()))
                 .to_str()
                 .unwrap(),
         );
@@ -600,7 +601,7 @@ async fn test_cached_block_info_merging() {
         let cache = read_cache(
             cache_dir
                 .path()
-                .join(format!("*v{CACHE_VERSION}.json"))
+                .join(format!("*v{}.json", cache_version()))
                 .to_str()
                 .unwrap(),
         );

crates/cheatnet/tests/starknet/forking.rs

@@ -1,6 +1,5 @@
 #[cfg(test)]
 mod tests {
-    use starknet::ContractAddress;
     use starknet::contract_address_const;
 
     #[starknet::interface]

crates/forge/tests/data/forking/.snfoundry_cache/http___188_34_188_184_7070_rpc_v0_7_54060_v0_38_0.json

@@ -19,6 +19,19 @@ rm snforge_std/Scarb.toml.bak 2> /dev/null
 sed -i.bak "/\[package\]/,/version =/ s/version = \".*/version = \"${VERSION}\"/" crates/snforge-scarb-plugin/Scarb.toml
 rm crates/snforge-scarb-plugin/Scarb.toml.bak 2> /dev/null
 
+# start: Update cache test data
+VERSION_UNDERSCORED=$(echo "$VERSION" | tr '.' '_')
+
+DIRECTORY="crates/forge/tests/data/forking/.snfoundry_cache"
+OLD_FILE_PATH=$(find "$DIRECTORY" -type f -regex '.*_v[0-9][0-9_]*\.json')
+NEW_FILE_PATH=$(echo "$OLD_FILE_PATH" | sed -E "s/_v[0-9_]+\.json$/_v${VERSION_UNDERSCORED}.json/")
+
+mv "$OLD_FILE_PATH" "$NEW_FILE_PATH"
+
+sed -i.bak -E "s/\"cache_version\":\"[0-9_]+\"/\"cache_version\":\"${VERSION_UNDERSCORED}\"/" "$NEW_FILE_PATH"
+rm "$NEW_FILE_PATH.bak" 2> /dev/null
+# end
+
 scarb --manifest-path snforge_std/Scarb.toml build
 
 cargo update -p forge