Improve output of sncast account create (#3347)

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

Closes #3254

## 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`

Author: kkawula

CHANGELOG.md

@@ -26,6 +26,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - OpenZeppelin account updated to v1.0.0 [preset](https://docs.openzeppelin.com/contracts-cairo/1.0.0/api/account#AccountUpgradeable)
 - Restored support for Braavos accounts
 - Accounts created with `--type braavos` use updated v1.2.0 class hash
+- Output of `sncast account create` is now clearer; the estimated fee is displayed in both STRK and FRI.
+- Renamed the field `max_fee` to `estimated_fee` in the `sncast account create` output.
 
 ## [0.43.1] - 2025-05-16
 

Cargo.lock

@@ -29,6 +29,7 @@ license-file = "LICENSE"
 
 [workspace.dependencies]
 blockifier = { git = "https://github.com/software-mansion-labs/sequencer.git", branch = "main-v0.13.5-modified-sierra-dep", default-features = false, features = ["testing", "tracing"] }
+bigdecimal = "0.4.8"
 starknet_api = { git = "https://github.com/software-mansion-labs/sequencer.git", branch = "main-v0.13.5-modified-sierra-dep" }
 cairo-lang-casm = { version = "2.11.2", features = ["serde"] }
 cairo-lang-sierra = "2.11.2"

Cargo.toml

@@ -7,6 +7,7 @@ edition.workspace = true
 [dependencies]
 anyhow.workspace = true
 camino.workspace = true
+bigdecimal.workspace = true
 clap.workspace = true
 clap_complete.workspace = true
 serde_json.workspace = true

crates/sncast/Cargo.toml

@@ -85,7 +85,7 @@ impl CommandResponse for DeclareResponse {}
 pub struct AccountCreateResponse {
     pub address: PaddedFelt,
     #[serde(serialize_with = "crate::response::structs::serialize_as_decimal")]
-    pub max_fee: Felt,
+    pub estimated_fee: Felt,
     pub add_profile: String,
     pub message: String,
 }

crates/sncast/src/response/structs.rs

@@ -2,6 +2,8 @@ use crate::starknet_commands::account::{
     generate_add_profile_message, prepare_account_json, write_account_to_accounts_file,
 };
 use anyhow::{Context, Result, anyhow, bail};
+use bigdecimal::BigDecimal;
+use bigdecimal::num_bigint::{BigInt, Sign};
 use camino::Utf8PathBuf;
 use clap::Args;
 use conversions::IntoConv;
@@ -76,15 +78,18 @@ pub async fn create(
     });
     check_class_hash_exists(provider, class_hash).await?;
 
-    let (account_json, max_fee) =
+    let (account_json, estimated_fee) =
         generate_account(provider, salt, class_hash, create.account_type).await?;
 
     let address: Felt = account_json["address"]
         .as_str()
         .context("Invalid address")?
         .parse()?;
 
-    let mut message = "Account successfully created. Prefund generated address with at least <max_fee> STRK tokens. It is good to send more in the case of higher demand.".to_string();
+    let mut message = format!(
+        "Account successfully created but it needs to be deployed. The estimated deployment fee is {} STRK. Prefund the account to cover deployment transaction fee",
+        felt_to_bigdecimal(estimated_fee, 18)
+    );
 
     if let Some(keystore) = keystore.clone() {
         let account_path = Utf8PathBuf::from(&account);
@@ -139,7 +144,7 @@ pub async fn create(
 
     Ok(AccountCreateResponse {
         address: address.into_(),
-        max_fee,
+        estimated_fee,
         add_profile: add_profile_message,
         message: if account_json["deployed"] == json!(false) {
             message
@@ -352,7 +357,7 @@ fn generate_deploy_command(
     let network_flag = generate_network_flag(rpc_url, network);
 
     format!(
-        "\n\nAfter prefunding the address, run:\n\
+        "\n\nAfter prefunding the account, run:\n\
         sncast{accounts_flag} account deploy {network_flag} --name {account}"
     )
 }
@@ -366,7 +371,71 @@ fn generate_deploy_command_with_keystore(
     let network_flag = generate_network_flag(rpc_url, network);
 
     format!(
-        "\n\nAfter prefunding the address, run:\n\
+        "\n\nAfter prefunding the account, run:\n\
         sncast --account {account} --keystore {keystore} account deploy {network_flag}"
     )
 }
+
+fn felt_to_bigdecimal<F, D>(felt: F, decimals: D) -> BigDecimal
+where
+    F: AsRef<Felt>,
+    D: Into<i64>,
+{
+    BigDecimal::new(
+        BigInt::from_bytes_be(Sign::Plus, &felt.as_ref().to_bytes_be()),
+        decimals.into(),
+    )
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_felt_to_bigdecimal_with_zero() {
+        let felt = Felt::ZERO;
+        let result = felt_to_bigdecimal(felt, 18);
+        assert_eq!(result, BigDecimal::from(0));
+    }
+
+    #[test]
+    fn test_felt_to_bigdecimal_with_one() {
+        let felt = Felt::ONE;
+        let result = felt_to_bigdecimal(felt, 18);
+        assert_eq!(result, BigDecimal::new(BigInt::from(1), 18));
+    }
+
+    #[test]
+    fn test_felt_to_bigdecimal_with_large_number() {
+        let felt = Felt::from_dec_str("1311768467463790320").unwrap();
+        let result = felt_to_bigdecimal(felt, 18);
+        let expected = BigDecimal::from_str("1.311768467463790320").unwrap();
+        assert_eq!(result, expected);
+    }
+
+    #[test]
+    fn test_felt_to_bigdecimal_with_different_decimals() {
+        let felt = Felt::from_hex("0x64").unwrap();
+        let result_0 = felt_to_bigdecimal(felt, 0);
+        let result_2 = felt_to_bigdecimal(felt, 2);
+
+        assert_eq!(result_0, BigDecimal::from(100));
+        assert_eq!(result_2, BigDecimal::new(BigInt::from(100), 2));
+    }
+    #[test]
+    fn test_felt_to_bigdecimal_common_token_value() {
+        let felt = Felt::from(1_500_000_000_000_000_000u128);
+        let result = felt_to_bigdecimal(felt, 18);
+        assert_eq!(result.to_string(), "1.500000000000000000");
+    }
+
+    #[test]
+    fn test_felt_to_bigdecimal_with_different_decimal_places() {
+        let felt = Felt::from(123_456_789);
+
+        assert_eq!(felt_to_bigdecimal(felt, 0).to_string(), "123456789");
+        assert_eq!(felt_to_bigdecimal(felt, 3).to_string(), "123456.789");
+        assert_eq!(felt_to_bigdecimal(felt, 6).to_string(), "123.456789");
+        assert_eq!(felt_to_bigdecimal(felt, 9).to_string(), "0.123456789");
+    }
+}

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

@@ -50,10 +50,10 @@ pub async fn test_happy_case(account_type: &str) {
         command: account create
         add_profile: --add-profile flag was not set. No profile added to snfoundry.toml
         address: 0x0[..]
-        max_fee: [..]
-        message: Account successfully created. Prefund generated address with at least <max_fee> STRK tokens. It is good to send more in the case of higher demand.
+        estimated_fee: [..]
+        message: Account successfully created but it needs to be deployed. The estimated deployment fee is [..]
 
-        After prefunding the address, run:
+        After prefunding the account, run:
         sncast --accounts-file accounts.json account deploy --url http://127.0.0.1:5055/rpc --name my_account
 
         To see account creation details, visit:
@@ -144,10 +144,10 @@ pub async fn test_happy_case_generate_salt() {
         command: account create
         add_profile: --add-profile flag was not set. No profile added to snfoundry.toml
         address: 0x0[..]
-        max_fee: [..]
-        message: Account successfully created[..]
+        estimated_fee: [..]
+        message: Account successfully created but it needs to be deployed. The estimated deployment fee is [..]
 
-        After prefunding the address, run:
+        After prefunding the account, run:
         sncast --accounts-file accounts.json account deploy --url http://127.0.0.1:5055/rpc --name my_account
 
         To see account creation details, visit:
@@ -230,10 +230,10 @@ pub async fn test_happy_case_accounts_file_already_exists() {
         command: account create
         add_profile: --add-profile flag was not set. No profile added to snfoundry.toml
         address: 0x0[..]
-        max_fee: [..]
-        message: Account successfully created[..]
+        estimated_fee: [..]
+        message: Account successfully created but it needs to be deployed. The estimated deployment fee is [..]
 
-        After prefunding the address, run:
+        After prefunding the account, run:
         sncast --accounts-file accounts.json account deploy --url http://127.0.0.1:5055/rpc --name my_account
 
         To see account creation details, visit:
@@ -362,10 +362,10 @@ pub async fn test_happy_case_keystore(account_type: &str) {
         command: account create
         add_profile: --add-profile flag was not set. No profile added to snfoundry.toml
         address: 0x0[..]
-        max_fee: [..]
-        message: Account successfully created[..]
+        estimated_fee: [..]
+        message: Account successfully created but it needs to be deployed. The estimated deployment fee is [..]
 
-        After prefunding the address, run:
+        After prefunding the account, run:
         sncast --account {} --keystore {} account deploy --url {}
 
         To see account creation details, visit:
@@ -565,10 +565,10 @@ pub async fn test_happy_case_keystore_int_format() {
         command: account create
         add_profile: --add-profile flag was not set. No profile added to snfoundry.toml
         address: [..]
-        max_fee: [..]
-        message: Account successfully created[..]
+        estimated_fee: [..]
+        message: Account successfully created but it needs to be deployed. The estimated deployment fee is [..]
 
-        After prefunding the address, run:
+        After prefunding the account, run:
         sncast --account {} --keystore {} account deploy --url {}
 
         To see account creation details, visit:
@@ -609,10 +609,10 @@ pub async fn test_happy_case_keystore_hex_format() {
         command: account create
         add_profile: --add-profile flag was not set. No profile added to snfoundry.toml
         address: 0x0[..]
-        max_fee: 0x[..]
-        message: Account successfully created[..]
+        estimated_fee: [..]
+        message: Account successfully created but it needs to be deployed. The estimated deployment fee is [..]
 
-        After prefunding the address, run:
+        After prefunding the account, run:
         sncast --account {} --keystore {} account deploy --url {}
 
         To see account creation details, visit:
@@ -661,10 +661,10 @@ pub async fn test_happy_case_default_name_generation() {
         command: account create
         add_profile: --add-profile flag was not set. No profile added to snfoundry.toml
         address: 0x0[..]
-        max_fee: [..]
-        message: Account successfully created. Prefund generated address with at least <max_fee> STRK tokens. It is good to send more in the case of higher demand.
+        estimated_fee: [..]
+        message: Account successfully created but it needs to be deployed. The estimated deployment fee is [..]
 
-        After prefunding the address, run:
+        After prefunding the account, run:
         sncast --accounts-file accounts.json account deploy --url http://127.0.0.1:5055/rpc --name account-{id}
 
         To see account creation details, visit:
@@ -695,10 +695,10 @@ pub async fn test_happy_case_default_name_generation() {
         command: account create
         add_profile: --add-profile flag was not set. No profile added to snfoundry.toml
         address: 0x0[..]
-        max_fee: [..]
-        message: Account successfully created. Prefund generated address with at least <max_fee> STRK tokens. It is good to send more in the case of higher demand.
-
-        After prefunding the address, run:
+        estimated_fee: [..]
+        message: Account successfully created but it needs to be deployed. The estimated deployment fee is [..]
+        
+        After prefunding the account, run:
         sncast --accounts-file accounts.json account deploy --url http://127.0.0.1:5055/rpc --name account-2
 
         To see account creation details, visit:
@@ -864,3 +864,18 @@ fn test_old_braavos_class_hashes_disabled(class_hash: &str) {
         "},
     );
 }
+
+#[tokio::test]
+pub async fn test_happy_case_deployment_fee_message() {
+    let tempdir = tempdir().expect("Failed to create a temporary directory");
+
+    let args = vec!["account", "create", "--url", URL];
+
+    let snapbox = runner(&args).current_dir(tempdir.path());
+    let output = snapbox.assert().success();
+
+    assert_stdout_contains(
+        output,
+        "message: Account successfully created but it needs to be deployed. The estimated deployment fee is 0.000836288000000000 STRK. Prefund the account to cover deployment transaction fee",
+    );
+}

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

@@ -21,10 +21,10 @@ $ sncast \
 ```shell
 command: account create
 add_profile: --add-profile flag was not set. No profile added to snfoundry.toml
-address: [..]
-max_fee: [..]
-message: Account successfully created. Prefund generated address with at least <max_fee> STRK tokens. It is good to send more in the case of higher demand.
-
+address: 0x0[..]
+estimated_fee: [..]
+message: Account successfully created but it needs to be deployed. The estimated deployment fee is [..]
+        
 To see account creation details, visit:
 account: https://sepolia.starkscan.co/contract/[..]
 ```

docs/src/development/shell-snippets.md

@@ -21,11 +21,11 @@ $ sncast account create \
 ```shell
 command: account create
 add_profile: --add-profile flag was not set. No profile added to snfoundry.toml
-address: 0x[..]
-max_fee: [..]
-message: Account successfully created. Prefund generated address with at least <max_fee> STRK tokens. It is good to send more in the case of higher demand.
+address: 0x0[..]
+estimated_fee: [..]
+message: Account successfully created but it needs to be deployed. The estimated deployment fee is [..]
 
-After prefunding the address, run:
+After prefunding the account, run:
 sncast account deploy --network sepolia --name my_account
 ```
 
@@ -39,7 +39,7 @@ At least `max_fee` amount of fri (1 STRK = 10<sup>18</sup> fri) should be sent.
 > On Sepolia, [this free faucet](https://starknet-faucet.vercel.app/) can be used to fund the account.
 
 
-Then, deploy the account using the command that was provided in output, below `After prefunding the address, run`:
+Then, deploy the account using the command that was provided in output, below `After prefunding the account, run`:
 
 <!-- { "ignored": true } -->
 ```shell

docs/src/starknet/101.md

@@ -37,9 +37,9 @@ $ sncast \
 ```shell
 command: account create
 add_profile: --add-profile flag was not set. No profile added to snfoundry.toml
-address: [..]
-max_fee: [..]
-message: Account successfully created. Prefund generated address with at least <max_fee> STRK tokens. It is good to send more in the case of higher demand.
+address: 0x0[..]
+estimated_fee: [..]
+message: Account successfully created but it needs to be deployed. The estimated deployment fee is [..]
 
 To see account creation details, visit:
 account: https://sepolia.starkscan.co/contract/[..]