Added sncast_std recommended version check (#1510)

commit-id:5b848aa5

Author: MaksymilianDemitraszek

Cargo.lock

@@ -38,6 +38,8 @@ num-traits.workspace = true
 cairo-felt.workspace = true
 cairo-vm.workspace = true
 blockifier.workspace = true
+semver.workspace = true
+console.workspace = true
 
 [dev-dependencies]
 ctor.workspace = true

crates/sncast/Cargo.toml

@@ -1,4 +1,5 @@
-use anyhow::Result;
+use anyhow::{Error, Result};
+use console::style;
 use serde_json::Value;
 use starknet::core::types::FieldElement;
 use std::{collections::HashMap, fmt::Display, str::FromStr};
@@ -163,6 +164,11 @@ fn apply_numbers_formatting(value: OutputValue, formatting: NumbersFormat) -> Ou
     }
 }
 
+pub fn print_as_warning(error: &Error) {
+    let warning_tag = style("Warning:").color256(11);
+    println!("{warning_tag} {error}");
+}
+
 #[cfg(test)]
 mod tests {
     use serde_json::{Map, Value};

crates/sncast/src/response/print.rs

@@ -4,7 +4,7 @@ use std::fs;
 use crate::starknet_commands::declare::BuildConfig;
 use crate::starknet_commands::{call, declare, deploy, invoke};
 use crate::{get_account, get_nonce, WaitForTx};
-use anyhow::{ensure, Context, Result};
+use anyhow::{anyhow, ensure, Context, Result};
 use blockifier::execution::common_hints::ExecutionMode;
 use blockifier::execution::deprecated_syscalls::DeprecatedSyscallSelector;
 use blockifier::execution::entry_point::{
@@ -35,10 +35,13 @@ use runtime::{
     CheatcodeHandlingResult, EnhancedHintError, ExtendedRuntime, ExtensionLogic, StarknetRuntime,
     SyscallHandlingResult,
 };
-use scarb_api::ScarbCommand;
+use scarb_api::{package_matches_version_requirement, ScarbCommand};
+use scarb_metadata::Metadata;
+use semver::{Comparator, Op, Version, VersionReq};
 use sncast::helpers::scarb_utils::{
     get_package_metadata, get_scarb_manifest, get_scarb_metadata_with_deps, CastConfig,
 };
+use sncast::response::print::print_as_warning;
 use sncast::response::structs::ScriptResponse;
 use starknet::accounts::Account;
 use starknet::core::types::{BlockId, BlockTag::Pending, FieldElement};
@@ -352,6 +355,32 @@ pub fn run(
     }
 }
 
+fn sncast_std_version_requirement() -> VersionReq {
+    let version = Version::parse(env!("CARGO_PKG_VERSION")).unwrap();
+    let comparator = Comparator {
+        op: Op::Exact,
+        major: version.major,
+        minor: Some(version.minor),
+        patch: Some(version.patch),
+        pre: version.pre,
+    };
+    VersionReq {
+        comparators: vec![comparator],
+    }
+}
+
+fn warn_if_sncast_std_not_compatible(scarb_metadata: &Metadata) -> Result<()> {
+    let sncast_std_version_requirement = sncast_std_version_requirement();
+    if !package_matches_version_requirement(
+        scarb_metadata,
+        "sncast_std",
+        &sncast_std_version_requirement,
+    )? {
+        print_as_warning(&anyhow!("Package sncast_std version does not meet the recommended version requirement {sncast_std_version_requirement}, it might result in unexpected behaviour"));
+    }
+    Ok(())
+}
+
 fn compile_script(path_to_scarb_toml: Option<Utf8PathBuf>) -> Result<Utf8PathBuf> {
     let scripts_manifest_path = path_to_scarb_toml.unwrap_or_else(|| {
         get_scarb_manifest()
@@ -370,6 +399,9 @@ fn compile_script(path_to_scarb_toml: Option<Utf8PathBuf>) -> Result<Utf8PathBuf
         .context("failed to compile script with scarb")?;
 
     let metadata = get_scarb_metadata_with_deps(&scripts_manifest_path)?;
+
+    warn_if_sncast_std_not_compatible(&metadata)?;
+
     let package_metadata = get_package_metadata(&metadata, &scripts_manifest_path)?;
 
     let filename = format!("{}.sierra.json", package_metadata.name);

crates/sncast/src/starknet_commands/script.rs

@@ -0,0 +1,15 @@
+[package]
+name = "old_sncast_std"
+version = "0.1.0"
+
+[dependencies]
+starknet = ">=2.3.0"
+sncast_std = { git = "https://github.com/foundry-rs/starknet-foundry.git", tag = "v0.13.1" }
+
+[lib]
+sierra = true
+casm = true
+
+[[target.starknet-contract]]
+sierra = true
+casm = true

crates/sncast/tests/data/scripts/old_sncast_std/scripts/Scarb.toml

@@ -0,0 +1,2 @@
+mod map_script;
+

crates/sncast/tests/data/scripts/old_sncast_std/scripts/src/lib.cairo

@@ -0,0 +1,5 @@
+use sncast_std::{
+    declare, deploy, invoke, call, DeclareResult, DeployResult, InvokeResult, CallResult, get_nonce
+};
+
+fn main() {}

crates/sncast/tests/data/scripts/old_sncast_std/scripts/src/map_script.cairo

@@ -101,3 +101,28 @@ async fn test_fail_when_using_starknet_syscall() {
         error: Got an exception while executing a hint: Custom Hint Error: Starknet syscalls are not supported
     "});
 }
+
+#[tokio::test]
+async fn test_incompatible_sncast_std_version() {
+    let script_name = "map_script";
+    let args = vec![
+        "--accounts-file",
+        "../../../accounts/accounts.json",
+        "--account",
+        "user4",
+        "--url",
+        URL,
+        "script",
+        &script_name,
+    ];
+
+    let snapbox = Command::new(cargo_bin!("sncast"))
+        .current_dir(SCRIPTS_DIR.to_owned() + "/old_sncast_std/scripts")
+        .args(args);
+
+    snapbox.assert().success().stdout_matches(indoc! {r"
+        ...
+        Warning: Package sncast_std version does not meet the recommended version requirement =0.13.1, it might result in unexpected behaviour
+        ...
+    "});
+}