From cf96a883ca3e31d5e0387a01b22057b60d38570c Mon Sep 17 00:00:00 2001
From: Christoph Burgdorf <christoph.burgdorf@gmail.com>
Date: Thu, 26 May 2022 15:03:28 +0200
Subject: [PATCH] Fix regression of stateMutability not being included in ABI

Closes #557
---
 crates/abi/src/function.rs  | 20 +++++++++++++++++++-
 newsfragments/722.bugfix.md |  1 +
 2 files changed, 20 insertions(+), 1 deletion(-)
 create mode 100644 newsfragments/722.bugfix.md

diff --git a/crates/abi/src/function.rs b/crates/abi/src/function.rs
index fb204e6fe9..242e970eb0 100644
--- a/crates/abi/src/function.rs
+++ b/crates/abi/src/function.rs
@@ -4,6 +4,16 @@ use serde::Serialize;
 
 use super::types::AbiType;
 
+/// The mutability of a public function.
+#[derive(Serialize, Debug, PartialEq, Eq, Clone)]
+#[serde(rename_all = "lowercase")]
+pub enum StateMutability {
+    Pure,
+    View,
+    Nonpayable,
+    Payable,
+}
+
 #[derive(Debug, Clone, PartialEq, Eq, Serialize)]
 pub struct AbiFunction {
     #[serde(rename = "type")]
@@ -11,6 +21,8 @@ pub struct AbiFunction {
     name: String,
     inputs: Vec<AbiFunctionParamInner>,
     outputs: Vec<AbiFunctionParamInner>,
+    #[serde(rename = "stateMutability")]
+    state_mutability: StateMutability
 }
 
 impl AbiFunction {
@@ -33,6 +45,10 @@ impl AbiFunction {
             name,
             inputs,
             outputs,
+            // In the future we will derive that based on the fact whether `self` or `ctx` are taken as `mut` or not.
+            // For now, we default to payable so that tooling such as hardhat simply assumes all functions need to be
+            // called with a transaction.
+            state_mutability: StateMutability::Payable
         }
     }
 
@@ -137,7 +153,7 @@ mod tests {
             &[
                 Token::Struct {
                     name: "AbiFunction",
-                    len: 4,
+                    len: 5,
                 },
                 Token::Str("type"),
                 Token::UnitVariant {
@@ -185,6 +201,8 @@ mod tests {
                 Token::String("uint64"),
                 Token::MapEnd,
                 Token::SeqEnd,
+                Token::Str("stateMutability"),
+                Token::UnitVariant { name: "StateMutability", variant: "payable", },
                 Token::StructEnd,
             ],
         )
diff --git a/newsfragments/722.bugfix.md b/newsfragments/722.bugfix.md
new file mode 100644
index 0000000000..681c3aac21
--- /dev/null
+++ b/newsfragments/722.bugfix.md
@@ -0,0 +1 @@
+Fix a regression where the `stateMutability` field would not be included in the generated ABI