From b2ce5efc5dfe5911faf2a1a5410c24f8ae527fee Mon Sep 17 00:00:00 2001
From: Ammar Arif <evergreenkary@gmail.com>
Date: Mon, 26 Aug 2024 15:04:16 -0400
Subject: [PATCH] hotfix(katana): include invalid nonce message in rpc error
 data

---
 .../rpc/rpc-types/src/error/starknet.rs       | 23 +++++++++++++++----
 1 file changed, 18 insertions(+), 5 deletions(-)

diff --git a/crates/katana/rpc/rpc-types/src/error/starknet.rs b/crates/katana/rpc/rpc-types/src/error/starknet.rs
index a01dcb701a..d5aecfb5dd 100644
--- a/crates/katana/rpc/rpc-types/src/error/starknet.rs
+++ b/crates/katana/rpc/rpc-types/src/error/starknet.rs
@@ -48,8 +48,11 @@ pub enum StarknetApiError {
     InvalidContractClass,
     #[error("Class already declared")]
     ClassAlreadyDeclared,
+    // TEMP: adding a reason field temporarily to match what's being returned by the gateway. the
+    // gateway includes the information regarding the expected and actual nonce in the error
+    // message. but this doesn't break compatibility with the spec.
     #[error("Invalid transaction nonce")]
-    InvalidTransactionNonce,
+    InvalidTransactionNonce { reason: String },
     #[error("Max fee is smaller than the minimal transaction cost (validation plus fee transfer)")]
     InsufficientMaxFee,
     #[error("Account balance is smaller than the transaction's max_fee")]
@@ -100,7 +103,7 @@ impl StarknetApiError {
             StarknetApiError::TransactionExecutionError { .. } => 41,
             StarknetApiError::InvalidContractClass => 50,
             StarknetApiError::ClassAlreadyDeclared => 51,
-            StarknetApiError::InvalidTransactionNonce => 52,
+            StarknetApiError::InvalidTransactionNonce { .. } => 52,
             StarknetApiError::InsufficientMaxFee => 53,
             StarknetApiError::InsufficientAccountBalance => 54,
             StarknetApiError::ValidationFailure { .. } => 55,
@@ -126,7 +129,8 @@ impl StarknetApiError {
             | StarknetApiError::UnexpectedError { .. }
             | StarknetApiError::TransactionExecutionError { .. } => Some(serde_json::json!(self)),
 
-            StarknetApiError::ValidationFailure { reason } => {
+            StarknetApiError::InvalidTransactionNonce { reason }
+            | StarknetApiError::ValidationFailure { reason } => {
                 Some(Value::String(reason.to_string()))
             }
 
@@ -179,8 +183,10 @@ impl From<Box<InvalidTransactionError>> for StarknetApiError {
         match error.as_ref() {
             InvalidTransactionError::InsufficientFunds { .. } => Self::InsufficientAccountBalance,
             InvalidTransactionError::InsufficientMaxFee { .. } => Self::InsufficientMaxFee,
-            InvalidTransactionError::InvalidNonce { .. } => Self::InvalidTransactionNonce,
             InvalidTransactionError::NonAccount { .. } => Self::NonAccount,
+            InvalidTransactionError::InvalidNonce { .. } => {
+                Self::InvalidTransactionNonce { reason: error.to_string() }
+            }
             InvalidTransactionError::ValidationFailure { error, .. } => {
                 Self::ValidationFailure { reason: error.to_string() }
             }
@@ -209,7 +215,6 @@ mod tests {
     #[case(StarknetApiError::PageSizeTooBig, 31, "Requested page size is too big")]
     #[case(StarknetApiError::FailedToReceiveTxn, 1, "Failed to write transaction")]
     #[case(StarknetApiError::InvalidMessageSelector, 21, "Invalid message selector")]
-    #[case(StarknetApiError::InvalidTransactionNonce, 52, "Invalid transaction nonce")]
     #[case(StarknetApiError::NonAccount, 58, "Sender address in not an account contract")]
     #[case(StarknetApiError::InvalidTxnIndex, 27, "Invalid transaction index in a block")]
     #[case(StarknetApiError::ProofLimitExceeded, 10000, "Too many storage keys requested")]
@@ -272,6 +277,14 @@ mod tests {
             "reason": "Unexpected error reason".to_string()
         }),
     )]
+    #[case(
+    	StarknetApiError::InvalidTransactionNonce {
+     		reason: "Wrong nonce".to_string()
+      	},
+     	52,
+      	"Invalid transaction nonce",
+       	Value::String("Wrong nonce".to_string())
+    )]
     #[case(
     	StarknetApiError::ValidationFailure {
      		reason: "Invalid signature".to_string()