Use strk as a default fee token

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Cast
+
+#### Changed
+
+- `--fee-token` and `--version` flags are now optional, `strk` and `v3` will be used by default
+
 ### `snforge_scarb_plugin`
 
 #### Changed

crates/sncast/src/helpers/fee.rs

@@ -5,11 +5,12 @@ use conversions::TryIntoConv;
 use starknet::core::types::BlockId;
 use starknet::providers::Provider;
 use starknet_types_core::felt::{Felt, NonZeroFelt};
+use std::str::FromStr;
 
 #[derive(Args, Debug, Clone)]
 pub struct FeeArgs {
     /// Token that transaction fee will be paid in
-    #[clap(long)]
+    #[clap(long, value_parser = parse_fee_token)]
     pub fee_token: Option<FeeToken>,
 
     /// Max fee for the transaction. If not provided, will be automatically estimated.
@@ -50,9 +51,9 @@ impl From<ScriptFeeSettings> for FeeArgs {
 
 impl FeeArgs {
     #[must_use]
-    pub fn fee_token(self, fee_token: Option<FeeToken>) -> Self {
+    pub fn fee_token(self, fee_token: FeeToken) -> Self {
         Self {
-            fee_token: fee_token.or(self.fee_token),
+            fee_token: Some(fee_token),
             ..self
         }
     }
@@ -138,9 +139,10 @@ impl FeeArgs {
     }
 }
 
-#[derive(ValueEnum, Debug, Clone, PartialEq)]
+#[derive(ValueEnum, Default, Debug, Clone, PartialEq)]
 pub enum FeeToken {
     Eth,
+    #[default]
     Strk,
 }
 
@@ -187,7 +189,7 @@ impl From<ScriptFeeSettings> for FeeSettings {
 
 pub trait PayableTransaction {
     fn error_message(&self, token: &str, version: &str) -> String;
-    fn validate(&self) -> Result<()>;
+    fn validate_and_get_token(&self) -> Result<FeeToken>;
     fn token_from_version(&self) -> Option<FeeToken>;
 }
 
@@ -199,21 +201,27 @@ macro_rules! impl_payable_transaction {
                 $err_func(token, version)
             }
 
-            fn validate(&self) -> Result<()> {
+            fn validate_and_get_token(&self) -> Result<FeeToken> {
                 match (
                     &self.token_from_version(),
                     &self.fee_args.fee_token,
                 ) {
                     (Some(token_from_version), Some(token)) if token_from_version != token => {
                         Err(anyhow!(self.error_message(
-                            &format!("{token:?}").to_lowercase(),
+                            &format!("{:?}", token).to_lowercase(),
                             &format!("{:?}", self.version.clone().unwrap()).to_lowercase()
                         )))
-                    }
+                    },
+                    (None, Some(token)) => {
+                        Ok(token.clone())
+                    },
+                    (Some(token_from_version), None) => {
+                        Ok(token_from_version.clone())
+                    },
                     (None, None) => {
-                        Err(anyhow!("Either --fee-token or --version must be provided"))
-                    }
-                    _ => Ok(()),
+                        Ok(FeeToken::default())
+                    },
+                    _ =>  Ok(self.fee_args.fee_token.clone().unwrap_or_else(|| self.token_from_version().unwrap_or_else(|| unreachable!())))
                 }
             }
 
@@ -225,3 +233,24 @@ macro_rules! impl_payable_transaction {
         }
     };
 }
+
+impl FromStr for FeeToken {
+    type Err = String;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s.to_lowercase().as_str() {
+            "eth" => Ok(FeeToken::Eth),
+            "strk" => Ok(FeeToken::Strk),
+            _ => Err(String::from("Possible values: eth, strk")),
+        }
+    }
+}
+
+fn parse_fee_token(s: &str) -> Result<FeeToken, String> {
+    match s.to_lowercase().as_str() {
+        "eth" => println!("\x1b[33mwarning:\x1b[0m Specifying '--fee-token' flag will be deprecated in the future and eth transactions will not be supported due to 'SNIP-16'. It is recommended to use '--version' instead"),
+        _ => println!("\x1b[33mwarning:\x1b[0m Specifying '--fee-token' flag will be deprecated in the future. It is recommended to use '--version' instead"),
+    }
+    let parsed_token: FeeToken = s.parse()?;
+    Ok(parsed_token)
+}

crates/sncast/src/main.rs

@@ -235,7 +235,7 @@ async fn run_async_command(
         Commands::Declare(declare) => {
             let provider = declare.rpc.get_provider(&config).await?;
 
-            declare.validate()?;
+            let fee_token = declare.validate_and_get_token()?;
 
             let account = get_account(
                 &config.account,
@@ -262,6 +262,7 @@ async fn run_async_command(
                 &artifacts,
                 wait_config,
                 false,
+                fee_token,
             )
             .await
             .map_err(handle_starknet_command_error)
@@ -286,9 +287,7 @@ async fn run_async_command(
         }
 
         Commands::Deploy(deploy) => {
-            deploy.validate()?;
-
-            let fee_token = deploy.token_from_version();
+            let fee_token = deploy.validate_and_get_token()?;
 
             let Deploy {
                 arguments,
@@ -378,9 +377,7 @@ async fn run_async_command(
         }
 
         Commands::Invoke(invoke) => {
-            invoke.validate()?;
-
-            let fee_token = invoke.token_from_version();
+            let fee_token = invoke.validate_and_get_token()?;
 
             let Invoke {
                 contract_address,
@@ -457,8 +454,6 @@ async fn run_async_command(
                 starknet_commands::multicall::Commands::Run(run) => {
                     let provider = run.rpc.get_provider(&config).await?;
 
-                    run.validate()?;
-
                     let account = get_account(
                         &config.account,
                         &config.accounts_file,
@@ -533,10 +528,12 @@ async fn run_async_command(
             }
 
             account::Commands::Deploy(deploy) => {
-                deploy.validate()?;
-
                 let provider = deploy.rpc.get_provider(&config).await?;
 
+                let fee_token = deploy.validate_and_get_token()?;
+
+                let fee_args = deploy.fee_args.clone().fee_token(fee_token);
+
                 let chain_id = get_chain_id(&provider).await?;
                 let keystore_path = config.keystore.clone();
                 let result = starknet_commands::account::deploy::deploy(
@@ -547,6 +544,7 @@ async fn run_async_command(
                     wait_config,
                     &config.account,
                     keystore_path,
+                    fee_args,
                 )
                 .await;
 

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

@@ -65,12 +65,8 @@ pub async fn deploy(
     wait_config: WaitForTx,
     account: &str,
     keystore_path: Option<Utf8PathBuf>,
+    fee_args: FeeArgs,
 ) -> Result<InvokeResponse> {
-    let fee_args = deploy_args
-        .fee_args
-        .clone()
-        .fee_token(deploy_args.token_from_version());
-
     if let Some(keystore_path_) = keystore_path {
         deploy_from_keystore(
             provider,

crates/sncast/src/starknet_commands/declare.rs

@@ -69,11 +69,12 @@ pub async fn declare(
     artifacts: &HashMap<String, StarknetContractArtifacts>,
     wait_config: WaitForTx,
     skip_on_already_declared: bool,
+    fee_token: FeeToken,
 ) -> Result<DeclareResponse, StarknetCommandError> {
     let fee_settings = declare
         .fee_args
         .clone()
-        .fee_token(declare.token_from_version())
+        .fee_token(fee_token)
         .try_into_fee_settings(account.provider(), account.block_id())
         .await?;
 

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

@@ -71,7 +71,9 @@ pub async fn run(
     account: &SingleOwnerAccount<&JsonRpcClient<HttpTransport>, LocalWallet>,
     wait_config: WaitForTx,
 ) -> Result<InvokeResponse> {
-    let fee_args = run.fee_args.clone().fee_token(run.token_from_version());
+    let fee_token = run.validate_and_get_token()?;
+
+    let fee_args = run.fee_args.clone().fee_token(fee_token);
 
     let contents = std::fs::read_to_string(&run.path)?;
     let items_map: HashMap<String, Vec<toml::Value>> =

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

@@ -35,7 +35,7 @@ use shared::utils::build_readable_text;
 use sncast::get_nonce;
 use sncast::helpers::configuration::CastConfig;
 use sncast::helpers::constants::SCRIPT_LIB_ARTIFACT_NAME;
-use sncast::helpers::fee::{FeeSettings, ScriptFeeSettings};
+use sncast::helpers::fee::{FeeArgs, FeeSettings, ScriptFeeSettings};
 use sncast::helpers::rpc::RpcArgs;
 use sncast::response::structs::ScriptRunResponse;
 use sncast::state::hashing::{
@@ -116,7 +116,8 @@ impl<'a> ExtensionLogic for CastScriptExtension<'a> {
             }
             "declare" => {
                 let contract: String = input_reader.read::<ByteArray>()?.to_string();
-                let fee_args = input_reader.read::<ScriptFeeSettings>()?.into();
+                let fee_args: FeeArgs = input_reader.read::<ScriptFeeSettings>()?.into();
+                let fee_token = fee_args.fee_token.clone().unwrap_or_default();
                 let nonce = input_reader.read()?;
 
                 let declare = Declare {
@@ -145,6 +146,7 @@ impl<'a> ExtensionLogic for CastScriptExtension<'a> {
                         wait_params: self.config.wait_params,
                     },
                     true,
+                    fee_token,
                 ));
 
                 self.state.maybe_insert_tx_entry(

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

@@ -349,7 +349,7 @@ async fn test_invalid_version_and_token_combination(fee_token: &str, version: &s
 }
 
 #[tokio::test]
-async fn test_no_version_and_token() {
+async fn test_default_fee_token() {
     let tempdir = create_account(false, &OZ_CLASS_HASH.into_hex_string(), "oz").await;
     let accounts_file = "accounts.json";
 
@@ -367,11 +367,14 @@ async fn test_no_version_and_token() {
 
     let snapbox = runner(&args).current_dir(tempdir.path());
 
-    let output = snapbox.assert().failure();
-    assert_stderr_contains(
-        output,
-        "Error: Either --fee-token or --version must be provided",
-    );
+    snapbox.assert().success().stdout_matches(indoc! {r"
+        Transaction hash: [..]
+        command: account deploy
+        transaction_hash: [..]
+
+        To see invocation details, visit:
+        transaction: [..]
+    "});
 }
 
 #[tokio::test]

docs/src/appendix/sncast/account/deploy.md

@@ -19,7 +19,7 @@ Optional.
 Maximum fee for the `deploy_account` transaction in Fri or Wei depending on fee token or transaction version. When not used, defaults to auto-estimation.
 
 ## `--fee-token <FEE_TOKEN>`
-Optional. Required if `--version` is not provided.
+Optional. When not used, defaults to STRK.
 
 Token used for fee payment. Possible values: ETH, STRK.
 
@@ -34,6 +34,6 @@ Optional.
 Maximum gas unit price for the `deploy_account` transaction paid in Fri. When not used, defaults to auto-estimation. (Only for STRK fee payment)
 
 ## `--version, -v <VERSION>`
-Optional. Required if `--fee-token` is not provided.
+Optional. When not used, defaults to v3.
 
 Version of the account deployment transaction. Possible values: v1, v3.

docs/src/appendix/sncast/declare.md

@@ -23,7 +23,7 @@ Optional.
 Maximum fee for the `declare` transaction in Fri or Wei depending on fee token or transaction version. When not used, defaults to auto-estimation.
 
 ## `--fee-token <FEE_TOKEN>`
-Optional. Required if `--version` is not provided.
+Optional. When not used, defaults to STRK.
 
 Token used for fee payment. Possible values: ETH, STRK.
 
@@ -38,7 +38,7 @@ Optional.
 Maximum gas unit price for the `declare` transaction paid in Fri. When not used, defaults to auto-estimation. (Only for STRK fee payment)
 
 ## `--version, -v <VERSION>`
-Optional. Required if `--fee-token` is not provided.
+Optional. When not used, defaults to v3.
 
 Version of the deployment transaction. Possible values: v2, v3.
 

docs/src/appendix/sncast/deploy.md

@@ -38,7 +38,7 @@ Optional.
 Maximum fee for the `deploy` transaction in Fri or Wei depending on fee token or transaction version. When not used, defaults to auto-estimation.
 
 ## `--fee-token <FEE_TOKEN>`
-Optional. Required if `--version` is not provided.
+Optional. When not used, defaults to STRK.
 
 Token used for fee payment. Possible values: ETH, STRK.
 
@@ -53,7 +53,7 @@ Optional.
 Maximum gas unit price for the `deploy` transaction paid in Fri. When not used, defaults to auto-estimation. (Only for STRK fee payment)
 
 ## `--version, -v <VERSION>`
-Optional. Required if `--fee-token` is not provided.
+Optional. When not used, defaults to v3.
 
 Version of the deployment transaction. Possible values: v1, v3.
 

docs/src/appendix/sncast/invoke.md

@@ -34,7 +34,7 @@ Optional.
 Maximum fee for the `invoke` transaction in Fri or Wei depending on fee token or transaction version. When not used, defaults to auto-estimation.
 
 ## `--fee-token <FEE_TOKEN>`
-Optional. Required if `--version` is not provided.
+Optional. When not used, defaults to STRK.
 
 Token used for fee payment. Possible values: ETH, STRK.
 
@@ -49,7 +49,7 @@ Optional.
 Maximum gas unit price for the `invoke` transaction paid in Fri. When not used, defaults to auto-estimation. (Only for STRK fee payment)
 
 ## `--version, -v <VERSION>`
-Optional. Required if `--fee-token` is not provided.
+Optional. When not used, defaults to v3.
 
 Version of the deployment transaction. Possible values: v1, v3.
 

docs/src/appendix/sncast/multicall/run.md

@@ -24,7 +24,7 @@ Optional.
 Maximum fee for the `invoke` transaction in Fri or Wei depending on fee token or transaction version. When not used, defaults to auto-estimation.
 
 ## `--fee-token <FEE_TOKEN>`
-Optional. Required if `--version` is not provided.
+Optional. When not used, defaults to STRK.
 
 Token used for fee payment. Possible values: ETH, STRK.
 
@@ -39,7 +39,7 @@ Optional.
 Maximum gas unit price for the `invoke` transaction paid in Fri. When not used, defaults to auto-estimation. (Only for STRK fee payment)
 
 ## `--version, -v <VERSION>`
-Optional. Required if `--fee-token` is not provided.
+Optional. When not used, defaults to v3.
 
 Version of the deployment transaction. Possible values: v1, v3.
 

docs/src/starknet/account.md

@@ -66,7 +66,6 @@ $ sncast \
     account deploy \
     --url http://127.0.0.1:5055 \
 	--name new_account \
-	--fee-token strk \
 	--max-fee 9999999999999
 ```
 
@@ -85,8 +84,6 @@ transaction: https://sepolia.starkscan.co/tx/[..]
 
 For a detailed CLI description, see [account deploy command reference](../appendix/sncast/account/deploy.md).
 
-> 💡 **Info**
-> You can also choose to pay in Ether by setting `--fee-token` to `eth`.
 
 ## Managing Accounts
 
@@ -211,7 +208,6 @@ $ sncast \
     declare \
 	--url http://127.0.0.1:5055 \
     --contract-name my_contract \
-    --fee-token eth
 ```
 
 #### Creating an Account With Starkli-Style Keystore