Add sncast get nonce (#4210)

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

Towards #4144

## Stack
- #4215 
- #4210

## Introduced changes

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

- `sncast nonce` command with flags:
  - `--contract-address`
  - `--block-id`

## Checklist

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

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

Author: DelevoXDG

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Cast
+
+#### Added
+
+- `sncast get nonce` command to get the nonce of a contract.
+
 ### Forge
 
 #### Added

crates/sncast/src/response/mod.rs

@@ -9,6 +9,7 @@ pub mod errors;
 pub mod explorer_link;
 pub mod invoke;
 pub mod multicall;
+pub mod nonce;
 pub mod script;
 pub mod show_config;
 pub mod transformed_call;

crates/sncast/src/response/nonce.rs

@@ -0,0 +1,21 @@
+use crate::response::cast_message::SncastCommandMessage;
+use conversions::serde::serialize::CairoSerialize;
+use conversions::string::IntoHexStr;
+use foundry_ui::styling;
+use serde::Serialize;
+use starknet_types_core::felt::Felt;
+
+#[derive(Serialize, CairoSerialize, Clone)]
+pub struct NonceResponse {
+    pub nonce: Felt,
+}
+
+impl SncastCommandMessage for NonceResponse {
+    fn text(&self) -> String {
+        styling::OutputBuilder::new()
+            .success_message("Nonce retrieved")
+            .blank_line()
+            .field("Nonce", &self.nonce.into_hex_string())
+            .build()
+    }
+}

crates/sncast/src/starknet_commands/get/mod.rs

@@ -3,6 +3,7 @@ use sncast::helpers::configuration::CastConfig;
 use sncast::response::ui::UI;
 
 pub mod balance;
+pub mod nonce;
 pub mod tx_status;
 
 #[derive(Args)]
@@ -19,13 +20,18 @@ pub enum GetCommands {
 
     /// Fetch balance of the account for specified token
     Balance(balance::Balance),
+
+    /// Get nonce of a contract
+    Nonce(nonce::Nonce),
 }
 
 pub async fn get(get: Get, config: CastConfig, ui: &UI) -> anyhow::Result<()> {
     match get.command {
         GetCommands::TxStatus(status) => tx_status::tx_status(status, config, ui).await?,
 
         GetCommands::Balance(balance) => balance::balance(balance, config, ui).await?,
+
+        GetCommands::Nonce(nonce) => nonce::nonce(nonce, config, ui).await?,
     }
 
     Ok(())

crates/sncast/src/starknet_commands/get/nonce.rs

@@ -0,0 +1,50 @@
+use anyhow::Result;
+use clap::Args;
+use sncast::get_block_id;
+use sncast::helpers::command::process_command_result;
+use sncast::helpers::configuration::CastConfig;
+use sncast::helpers::rpc::RpcArgs;
+use sncast::response::errors::{SNCastProviderError, StarknetCommandError};
+use sncast::response::nonce::NonceResponse;
+use sncast::response::ui::UI;
+use starknet_rust::providers::jsonrpc::HttpTransport;
+use starknet_rust::providers::{JsonRpcClient, Provider};
+use starknet_types_core::felt::Felt;
+
+#[derive(Debug, Args)]
+#[command(about = "Get the nonce of a contract")]
+pub struct Nonce {
+    /// Address of the contract
+    pub contract_address: Felt,
+
+    /// Block identifier on which nonce should be fetched.
+    /// Possible values: `pre_confirmed`, `latest`, block hash (0x prefixed string)
+    /// and block number (u64)
+    #[arg(short, long, default_value = "pre_confirmed")]
+    pub block_id: String,
+
+    #[command(flatten)]
+    pub rpc: RpcArgs,
+}
+
+pub async fn nonce(nonce: Nonce, config: CastConfig, ui: &UI) -> Result<()> {
+    let provider = nonce.rpc.get_provider(&config, ui).await?;
+
+    let result = get_nonce(&provider, nonce.contract_address, &nonce.block_id).await;
+
+    process_command_result("get nonce", result, ui, None);
+    Ok(())
+}
+
+pub async fn get_nonce(
+    provider: &JsonRpcClient<HttpTransport>,
+    contract_address: Felt,
+    block_id: &str,
+) -> Result<NonceResponse> {
+    let block_id = get_block_id(block_id)?;
+    let nonce = provider
+        .get_nonce(block_id, contract_address)
+        .await
+        .map_err(|err| StarknetCommandError::ProviderError(SNCastProviderError::from(err)))?;
+    Ok(NonceResponse { nonce })
+}

crates/sncast/tests/e2e/mod.rs

@@ -11,6 +11,7 @@ mod fee;
 mod invoke;
 mod main_tests;
 mod multicall;
+mod nonce;
 mod script;
 mod serialize;
 mod show_config;

crates/sncast/tests/e2e/nonce.rs

@@ -0,0 +1,97 @@
+use crate::helpers::constants::{DEVNET_PREDEPLOYED_ACCOUNT_ADDRESS, URL};
+use crate::helpers::runner::runner;
+use indoc::indoc;
+use shared::test_utils::output_assert::assert_stderr_contains;
+
+#[tokio::test]
+async fn test_happy_case() {
+    let args = vec![
+        "get",
+        "nonce",
+        DEVNET_PREDEPLOYED_ACCOUNT_ADDRESS,
+        "--url",
+        URL,
+    ];
+    let snapbox = runner(&args);
+
+    snapbox.assert().success().stdout_eq(indoc! {r"
+        Success: Nonce retrieved
+
+        Nonce: 0x[..]
+    "});
+}
+
+#[tokio::test]
+async fn test_happy_case_with_block_id() {
+    let args = vec![
+        "get",
+        "nonce",
+        DEVNET_PREDEPLOYED_ACCOUNT_ADDRESS,
+        "--block-id",
+        "latest",
+        "--url",
+        URL,
+    ];
+    let snapbox = runner(&args);
+
+    snapbox.assert().success().stdout_eq(indoc! {r"
+        Success: Nonce retrieved
+
+        Nonce: 0x[..]
+    "});
+}
+
+#[tokio::test]
+async fn test_happy_case_json() {
+    let args = vec![
+        "--json",
+        "get",
+        "nonce",
+        DEVNET_PREDEPLOYED_ACCOUNT_ADDRESS,
+        "--url",
+        URL,
+    ];
+    let snapbox = runner(&args);
+
+    snapbox.assert().success().stdout_eq(indoc! {r#"
+        {"command":"get nonce","nonce":"0x[..]","type":"response"}
+    "#});
+}
+
+#[tokio::test]
+async fn test_nonexistent_contract_address() {
+    let args = vec!["get", "nonce", "0x0", "--url", URL];
+    let snapbox = runner(&args);
+    let output = snapbox.assert().success();
+
+    assert_stderr_contains(
+        output,
+        indoc! {r"
+        Command: get nonce
+        Error: There is no contract at the specified address
+        "},
+    );
+}
+
+#[tokio::test]
+async fn test_invalid_block_id() {
+    let args = vec![
+        "get",
+        "nonce",
+        DEVNET_PREDEPLOYED_ACCOUNT_ADDRESS,
+        "--block-id",
+        "invalid_block",
+        "--url",
+        URL,
+    ];
+    let snapbox = runner(&args);
+    let output = snapbox.assert().success();
+
+    assert_stderr_contains(
+        output,
+        indoc! {r"
+        Command: get nonce
+        Error: Incorrect value passed for block_id = invalid_block. Possible values are `pre_confirmed`, `latest`, block hash (hex) and block number (u64)
+        "},
+    );
+}

docs/src/SUMMARY.md

@@ -156,6 +156,7 @@
     * [completions](appendix/sncast/completions.md)
     * [get](appendix/sncast/get/get.md)
         * [balance](appendix/sncast/get/balance.md)
+        * [nonce](appendix/sncast/get/nonce.md)
         * [tx-status](appendix/sncast/get/tx-status.md)
     * [utils](appendix/sncast/utils/utils.md)
         * [serialize](appendix/sncast/utils/serialize.md)

docs/src/appendix/sncast.md

@@ -19,8 +19,9 @@
     * [run](./sncast/script/run.md)
 * [show-config](./sncast/show_config.md)
 * [get](./sncast/get/get.md)
-  * [balance](./sncast/get/balance.md)
-  * [tx-status](./sncast/get/tx-status.md)
+    * [balance](./sncast/get/balance.md)
+    * [nonce](./sncast/get/nonce.md)
+    * [tx-status](./sncast/get/tx-status.md)
 * [utils](./sncast/utils/utils.md)
     * [serialize](./sncast/utils/serialize.md)
     * [class-hash](./sncast/utils/class_hash.md)

docs/src/appendix/sncast/get/nonce.md

@@ -0,0 +1,32 @@
+# `get nonce`
+
+Get the nonce of the specified contract.
+
+## `<CONTRACT_ADDRESS>`
+
+Required.
+
+Address of the contract in hex (prefixed with '0x') or decimal representation.
+
+## `--block-id, -b <BLOCK_ID>`
+Optional.
+
+Block identifier on which nonce should be fetched.
+Possible values: `pre_confirmed`, `latest`, block hash (0x prefixed string), and block number (u64).
+`pre_confirmed` is used as a default value.
+
+## `--url, -u <RPC_URL>`
+Optional.
+
+Starknet RPC node url address.
+
+Overrides url from `snfoundry.toml`.
+
+## `--network <NETWORK>`
+Optional.
+
+Use predefined network with public provider
+
+Possible values: `mainnet`, `sepolia`, `devnet`.
+
+Overrides network from `snfoundry.toml`.