Merge branch 'master' into franciszekjob/sncast-guidelines

.gitattributes

@@ -1 +1,4 @@
 *.* text eol=lf
+*.png -text
+*.jpg -text
+*.gif -text

.github/workflows/scheduled.yml

@@ -11,6 +11,7 @@ on:
 
 jobs:
   get-scarb-versions:
+    if: "! github.event.repository.fork"
     name: Get Scarb versions
     outputs:
       versions: ${{ steps.get_versions.outputs.versions }}
@@ -30,6 +31,7 @@ jobs:
           echo "versions=[${scarb_versions[@]}]" >> "$GITHUB_OUTPUT"
 
   test-forge-unit-and-integration:
+    if: "! github.event.repository.fork"
     runs-on: ubuntu-latest
     needs: get-scarb-versions
     strategy:
@@ -50,6 +52,7 @@ jobs:
       - run: cargo test --release -p forge integration
 
   test-forge-e2e:
+    if: "! github.event.repository.fork"
     runs-on: ubuntu-latest
     needs: get-scarb-versions
     strategy:
@@ -89,6 +92,7 @@ jobs:
       - run: cargo test --release -p forge e2e
 
   test-cast:
+    if: "! github.event.repository.fork"
     runs-on: ubuntu-latest
     needs: get-scarb-versions
     strategy:

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.36.0] - 2025-01-15
+
 ### Forge
 
 #### Changed
@@ -24,6 +26,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Values passed to the `--max-fee`, `--max-gas`, and `--max-gas-unit-price` flags must be greater than 0
 
+#### Deprecated
+
+- `--version` flag
+
 ## [0.35.1] - 2024-12-16
 
 ### Forge

Cargo.toml

@@ -18,7 +18,7 @@ members = [
 ]
 
 [workspace.package]
-version = "0.35.1"
+version = "0.36.0"
 edition = "2021"
 repository = "https://github.com/foundry-rs/starknet-foundry"
 license = "MIT"

crates/sncast/src/helpers/fee.rs

@@ -61,6 +61,7 @@ impl FeeArgs {
         }
     }
 
+    #[allow(clippy::too_many_lines)]
     pub async fn try_into_fee_settings<P: Provider>(
         &self,
         provider: P,
@@ -106,6 +107,7 @@ impl FeeArgs {
 
                         let max_gas = NonZeroFelt::try_from(Felt::from(max_fee).floor_div(&max_gas_unit_price))
                         .unwrap_or_else(|_| unreachable!("Calculated max gas must be >= 1 because max_fee >= max_gas_unit_price ensures a positive result"));
+                        print_max_fee_conversion_info(max_fee, max_gas, max_gas_unit_price);
                         FeeSettings::Strk {
                             max_gas: Some(
                                 NonZeroU64::try_from_(max_gas).map_err(anyhow::Error::msg)?,
@@ -123,6 +125,7 @@ impl FeeArgs {
 
                         let max_gas_unit_price = NonZeroFelt::try_from(Felt::from(max_fee).floor_div(&max_gas))
                         .unwrap_or_else(|_| unreachable!("Calculated max gas unit price must be >= 1 because max_fee >= max_gas ensures a positive result"));
+                        print_max_fee_conversion_info(max_fee, max_gas, max_gas_unit_price);
                         FeeSettings::Strk {
                             max_gas: Some(
                                 NonZeroU64::try_from_(max_gas).map_err(anyhow::Error::msg)?,
@@ -144,6 +147,7 @@ impl FeeArgs {
                         // TODO(#2852)
                         let max_gas = NonZeroFelt::try_from(Felt::from(max_fee)
                             .floor_div(&max_gas_unit_price)).context("Calculated max-gas from provided --max-fee and the current network gas price is 0. Please increase --max-fee to obtain a positive gas amount")?;
+                        print_max_fee_conversion_info(max_fee, max_gas, max_gas_unit_price);
                         FeeSettings::Strk {
                             max_gas: Some(
                                 NonZeroU64::try_from_(max_gas).map_err(anyhow::Error::msg)?,
@@ -270,7 +274,8 @@ impl FromStr for FeeToken {
 }
 
 fn parse_fee_token(s: &str) -> Result<FeeToken, String> {
-    let deprecation_message = "Specifying '--fee-token' flag is deprecated and will be removed in the future. Use '--version' instead";
+    let deprecation_message =
+        "Specifying '--fee-token' flag is deprecated and will be removed in the future.";
     print_as_warning(&Error::msg(deprecation_message));
 
     let parsed_token: FeeToken = s.parse()?;
@@ -284,6 +289,19 @@ fn parse_fee_token(s: &str) -> Result<FeeToken, String> {
     Ok(parsed_token)
 }
 
+fn print_max_fee_conversion_info(
+    max_fee: impl Into<Felt>,
+    max_gas: impl Into<Felt>,
+    max_gas_unit_price: impl Into<Felt>,
+) {
+    let max_fee: Felt = max_fee.into();
+    let max_gas: Felt = max_gas.into();
+    let max_gas_unit_price: Felt = max_gas_unit_price.into();
+    println!(
+        "Specifying '--max-fee' flag while using v3 transactions results in conversion to '--max-gas' and '--max-gas-unit-price' flags\nConverted {max_fee} max fee to {max_gas} max gas and {max_gas_unit_price} max gas unit price\n",
+    );
+}
+
 fn parse_non_zero_felt(s: &str) -> Result<NonZeroFelt, String> {
     let felt: Felt = s.parse().map_err(|_| "Failed to parse value")?;
     felt.try_into()

crates/sncast/src/helpers/mod.rs

@@ -8,3 +8,4 @@ pub mod fee;
 pub mod interactive;
 pub mod rpc;
 pub mod scarb_utils;
+pub mod version;

crates/sncast/src/helpers/version.rs

@@ -0,0 +1,10 @@
+use anyhow::Error;
+use clap::ValueEnum;
+use shared::print::print_as_warning;
+
+const DEPRECATION_MESSAGE: &str = "The '--version' flag is deprecated and will be removed in the future. Version 3 will become the only type of transaction available.";
+
+pub fn parse_version<T: ValueEnum>(s: &str) -> Result<T, String> {
+    print_as_warning(&Error::msg(DEPRECATION_MESSAGE));
+    T::from_str(s, true)
+}

crates/sncast/src/starknet_commands/account/deploy.rs

@@ -8,6 +8,7 @@ use sncast::helpers::constants::{BRAAVOS_BASE_ACCOUNT_CLASS_HASH, KEYSTORE_PASSW
 use sncast::helpers::error::token_not_supported_for_deployment;
 use sncast::helpers::fee::{FeeArgs, FeeSettings, FeeToken, PayableTransaction};
 use sncast::helpers::rpc::RpcArgs;
+use sncast::helpers::version::parse_version;
 use sncast::response::structs::InvokeResponse;
 use sncast::{
     apply_optional, chain_id_to_network_name, check_account_file_exists,
@@ -38,7 +39,7 @@ pub struct Deploy {
     pub fee_args: FeeArgs,
 
     /// Version of the account deployment (can be inferred from fee token)
-    #[clap(short, long)]
+    #[clap(short, long, value_parser = parse_version::<AccountDeployVersion>)]
     pub version: Option<AccountDeployVersion>,
 
     #[clap(flatten)]

crates/sncast/src/starknet_commands/declare.rs

@@ -6,6 +6,7 @@ use scarb_api::StarknetContractArtifacts;
 use sncast::helpers::error::token_not_supported_for_declaration;
 use sncast::helpers::fee::{FeeArgs, FeeSettings, FeeToken, PayableTransaction};
 use sncast::helpers::rpc::RpcArgs;
+use sncast::helpers::version::parse_version;
 use sncast::response::errors::StarknetCommandError;
 use sncast::response::structs::{
     AlreadyDeclaredResponse, DeclareResponse, DeclareTransactionResponse,
@@ -44,7 +45,7 @@ pub struct Declare {
     pub package: Option<String>,
 
     /// Version of the declaration (can be inferred from fee token)
-    #[clap(short, long)]
+    #[clap(short, long, value_parser = parse_version::<DeclareVersion>)]
     pub version: Option<DeclareVersion>,
 
     #[clap(flatten)]

crates/sncast/src/starknet_commands/deploy.rs

@@ -4,6 +4,7 @@ use conversions::IntoConv;
 use sncast::helpers::error::token_not_supported_for_deployment;
 use sncast::helpers::fee::{FeeArgs, FeeSettings, FeeToken, PayableTransaction};
 use sncast::helpers::rpc::RpcArgs;
+use sncast::helpers::version::parse_version;
 use sncast::response::errors::StarknetCommandError;
 use sncast::response::structs::DeployResponse;
 use sncast::{extract_or_generate_salt, impl_payable_transaction, udc_uniqueness};
@@ -43,7 +44,7 @@ pub struct Deploy {
     pub nonce: Option<Felt>,
 
     /// Version of the deployment (can be inferred from fee token)
-    #[clap(short, long)]
+    #[clap(short, long, value_parser = parse_version::<DeployVersion>)]
     pub version: Option<DeployVersion>,
 
     #[clap(flatten)]

crates/sncast/src/starknet_commands/invoke.rs

@@ -5,6 +5,7 @@ use conversions::IntoConv;
 use sncast::helpers::error::token_not_supported_for_invoke;
 use sncast::helpers::fee::{FeeArgs, FeeSettings, FeeToken, PayableTransaction};
 use sncast::helpers::rpc::RpcArgs;
+use sncast::helpers::version::parse_version;
 use sncast::response::errors::StarknetCommandError;
 use sncast::response::structs::InvokeResponse;
 use sncast::{apply_optional, handle_wait_for_tx, impl_payable_transaction, WaitForTx};
@@ -38,7 +39,7 @@ pub struct Invoke {
     pub nonce: Option<Felt>,
 
     /// Version of invoke (can be inferred from fee token)
-    #[clap(short, long)]
+    #[clap(short, long, value_parser = parse_version::<InvokeVersion>)]
     pub version: Option<InvokeVersion>,
 
     #[clap(flatten)]

crates/sncast/src/starknet_commands/multicall/run.rs

@@ -8,6 +8,7 @@ use sncast::helpers::constants::UDC_ADDRESS;
 use sncast::helpers::error::token_not_supported_for_invoke;
 use sncast::helpers::fee::{FeeArgs, FeeToken, PayableTransaction};
 use sncast::helpers::rpc::RpcArgs;
+use sncast::helpers::version::parse_version;
 use sncast::response::errors::handle_starknet_command_error;
 use sncast::response::structs::InvokeResponse;
 use sncast::{extract_or_generate_salt, impl_payable_transaction, udc_uniqueness, WaitForTx};
@@ -31,7 +32,7 @@ pub struct Run {
     pub fee_args: FeeArgs,
 
     /// Version of invoke (can be inferred from fee token)
-    #[clap(short, long)]
+    #[clap(short, long, value_parser = parse_version::<InvokeVersion>)]
     pub version: Option<InvokeVersion>,
 
     #[clap(flatten)]

crates/sncast/tests/e2e/account/deploy.rs

@@ -399,7 +399,7 @@ async fn test_fee_token_deprecation_warning_eth() {
     let snapbox = runner(&args).current_dir(tempdir.path());
 
     snapbox.assert().success().stdout_matches(indoc! {r"
-        [WARNING] Specifying '--fee-token' flag is deprecated and will be removed in the future. Use '--version' instead
+        [WARNING] Specifying '--fee-token' flag is deprecated and will be removed in the future.
         [WARNING] Eth transactions will stop being supported in the future due to 'SNIP-16'
         Transaction hash: [..]
         command: account deploy
@@ -432,7 +432,39 @@ async fn test_fee_token_deprecation_warning_strk() {
     let snapbox = runner(&args).current_dir(tempdir.path());
 
     snapbox.assert().success().stdout_matches(indoc! {r"
-        [WARNING] Specifying '--fee-token' flag is deprecated and will be removed in the future. Use '--version' instead
+        [WARNING] Specifying '--fee-token' flag is deprecated and will be removed in the future.
+        Transaction hash: [..]
+        command: account deploy
+        transaction_hash: [..]
+
+        To see invocation details, visit:
+        transaction: [..]
+    "});
+}
+
+#[tokio::test]
+async fn test_version_deprecation_warning() {
+    let tempdir = create_account(false, &OZ_CLASS_HASH.into_hex_string(), "oz").await;
+    let accounts_file = "accounts.json";
+
+    let args = vec![
+        "--accounts-file",
+        accounts_file,
+        "--wait",
+        "account",
+        "deploy",
+        "--url",
+        URL,
+        "--name",
+        "my_account",
+        "--version",
+        "v3",
+    ];
+
+    let snapbox = runner(&args).current_dir(tempdir.path());
+
+    snapbox.assert().success().stdout_matches(indoc! {r"
+        [WARNING] The '--version' flag is deprecated and will be removed in the future. Version 3 will become the only type of transaction available.
         Transaction hash: [..]
         command: account deploy
         transaction_hash: [..]
@@ -463,6 +495,9 @@ pub async fn test_valid_class_hash() {
     let snapbox = runner(&args).current_dir(tempdir.path());
 
     snapbox.assert().success().stdout_matches(indoc! {r"
+        Specifying '--max-fee' flag while using v3 transactions results in conversion to '--max-gas' and '--max-gas-unit-price' flags
+        Converted [..] max fee to [..] max gas and [..] max gas unit price
+
         command: account deploy
         transaction_hash: [..]
 
@@ -584,6 +619,9 @@ pub async fn test_happy_case_keystore(account_type: &str) {
     let snapbox = runner(&args).current_dir(tempdir.path());
 
     snapbox.assert().stdout_matches(indoc! {r"
+        Specifying '--max-fee' flag while using v3 transactions results in conversion to '--max-gas' and '--max-gas-unit-price' flags
+        Converted [..] max fee to [..] max gas and [..] max gas unit price
+
         command: account deploy
         transaction_hash: 0x0[..]
 
@@ -857,6 +895,9 @@ pub async fn test_deploy_keystore_other_args() {
 
     let snapbox = runner(&args).current_dir(tempdir.path());
     snapbox.assert().stdout_matches(indoc! {r"
+        Specifying '--max-fee' flag while using v3 transactions results in conversion to '--max-gas' and '--max-gas-unit-price' flags
+        Converted [..] max fee to [..] max gas and [..] max gas unit price
+
         command: account deploy
         transaction_hash: 0x0[..]
 

crates/sncast/tests/e2e/declare.rs

@@ -729,3 +729,40 @@ async fn test_no_scarb_profile() {
         "},
     );
 }
+
+#[tokio::test]
+async fn test_version_deprecation_warning() {
+    let contract_path = duplicate_contract_directory_with_salt(
+        CONTRACTS_DIR.to_string() + "/map",
+        "put",
+        "human_readable",
+    );
+    let tempdir = create_and_deploy_oz_account().await;
+    join_tempdirs(&contract_path, &tempdir);
+
+    let args = vec![
+        "--accounts-file",
+        "accounts.json",
+        "--account",
+        "my_account",
+        "declare",
+        "--url",
+        URL,
+        "--contract-name",
+        "Map",
+        "--max-fee",
+        "99999999999999999",
+        "--version",
+        "v3",
+    ];
+
+    let snapbox = runner(&args).current_dir(tempdir.path());
+    let output = snapbox.assert().success();
+
+    assert_stdout_contains(
+        output,
+        indoc! {r"
+        [WARNING] The '--version' flag is deprecated and will be removed in the future. Version 3 will become the only type of transaction available.
+    " },
+    );
+}