From 46d7afd65bdcde4171d778523a0eab1ed2ad27e7 Mon Sep 17 00:00:00 2001
From: oblique <psyberbits@gmail.com>
Date: Sat, 5 Mar 2022 20:25:03 +0200
Subject: [PATCH] fix(abigen): safe ident field names (#989)

---
 CHANGELOG.md                                         |  7 +++++++
 .../ethers-contract-abigen/src/contract/structs.rs   |  4 ++--
 ethers-contract/tests/abigen.rs                      | 12 ++++++++++++
 3 files changed, 21 insertions(+), 2 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index bbb59e47..1fa750c8 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -50,6 +50,13 @@
 
 ## ethers-contract-abigen
 
+### Unreleased
+
+- Generate correct bindings of struct's field names that are reserved words
+  [#989](https://github.com/gakonst/ethers-rs/pull/989).
+
+### 0.6.0
+
 - Add `MultiAbigen` to generate a series of contract bindings that can be kept in the repo
   [#724](https://github.com/gakonst/ethers-rs/pull/724).
 - Add provided `event_derives` to call and event enums as well
diff --git a/ethers-contract/ethers-contract-abigen/src/contract/structs.rs b/ethers-contract/ethers-contract-abigen/src/contract/structs.rs
index d57c8ea5..bb08335f 100644
--- a/ethers-contract/ethers-contract-abigen/src/contract/structs.rs
+++ b/ethers-contract/ethers-contract-abigen/src/contract/structs.rs
@@ -107,7 +107,7 @@ impl Context {
             if is_tuple {
                 fields.push(ty);
             } else {
-                let field_name = util::ident(&field.name().to_snake_case());
+                let field_name = util::safe_ident(&field.name().to_snake_case());
                 fields.push(quote! { pub #field_name: #ty });
             }
         }
@@ -155,7 +155,7 @@ impl Context {
         let mut fields = Vec::with_capacity(sol_struct.fields().len());
         let mut param_types = Vec::with_capacity(sol_struct.fields().len());
         for field in sol_struct.fields() {
-            let field_name = util::ident(&field.name().to_snake_case());
+            let field_name = util::safe_ident(&field.name().to_snake_case());
             match field.r#type() {
                 FieldType::Elementary(ty) => {
                     param_types.push(ty.clone());
diff --git a/ethers-contract/tests/abigen.rs b/ethers-contract/tests/abigen.rs
index 4afcec6f..80f5616c 100644
--- a/ethers-contract/tests/abigen.rs
+++ b/ethers-contract/tests/abigen.rs
@@ -518,3 +518,15 @@ fn can_gen_multi_etherscan() {
     let _contract = MyContract::new(Address::default(), Arc::clone(&provider));
     let _contract = MyContract2::new(Address::default(), provider);
 }
+
+#[test]
+fn can_gen_reserved_word_field_names() {
+    abigen!(
+        Test,
+        r#"[
+        struct Foo { uint256 ref; }
+    ]"#,
+    );
+
+    let _foo = Foo { ref_: U256::default() };
+}