Solidity ABI compatibility metadata improvements (#2511)

* More deserializable Solidity compatibility metadata

* Generate metadata for all constructors

* Update changelog

Author: davidsemakula

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 - Use marker trait for finding ink! storage `struct` during code analysis - [2499](https://github.com/use-ink/ink/pull/2499)
+- Solidity ABI compatibility metadata improvements - [#2511](https://github.com/use-ink/ink/pull/2511)
 
 ### Fixed
 - Update metadata version to version 6 ‒ [#2507](https://github.com/use-ink/ink/pull/2507)

crates/ink/codegen/src/generator/event.rs

@@ -106,10 +106,10 @@ impl Event<'_> {
 
             quote! {
                 ::ink::metadata::sol::EventParamMetadata {
-                    name: #name,
-                    ty: #sol_ty,
+                    name: #name.into(),
+                    ty: #sol_ty.into(),
                     is_topic: #is_topic,
-                    docs: #docs,
+                    docs: #docs.into(),
                 }
             }
         });
@@ -129,10 +129,10 @@ impl Event<'_> {
                 #[linkme(crate = ::ink::linkme)]
                 static EVENT_METADATA_SOL: fn() -> ::ink::metadata::sol::EventMetadata = || {
                     ::ink::metadata::sol::EventMetadata {
-                        name: #name,
+                        name: #name.into(),
                         is_anonymous: #is_anonymous,
                         params: vec![ #( #params ),* ],
-                        docs: #docs,
+                        docs: #docs.into(),
                     }
                 };
             };

crates/ink/codegen/src/generator/sol/metadata.rs

@@ -17,7 +17,6 @@ use ir::{
     Callable as _,
     InputsIter,
 };
-use itertools::Itertools;
 use proc_macro2::TokenStream as TokenStream2;
 use quote::quote;
 use syn::Pat;
@@ -40,7 +39,7 @@ impl GenerateCode for SolidityMetadata<'_> {
     fn generate_code(&self) -> TokenStream2 {
         let ident = self.contract.module().storage().ident();
         let name = ident.to_string();
-        let ctor = self.constructor();
+        let ctors = self.constructors();
         let msgs = self.messages();
         let docs = extract_docs(self.contract.module().attrs());
 
@@ -52,11 +51,11 @@ impl GenerateCode for SolidityMetadata<'_> {
                 #[no_mangle]
                 pub fn __ink_generate_solidity_metadata() -> ::ink::metadata::sol::ContractMetadata  {
                     ::ink::metadata::sol::ContractMetadata {
-                        name: #name,
-                        constructor: #ctor,
+                        name: #name.into(),
+                        constructors: vec![ #( #ctors ),* ],
                         functions: vec![ #( #msgs ),* ],
                         events: ::ink::collect_events_sol(),
-                        docs: #docs,
+                        docs: #docs.into(),
                     }
                 }
             };
@@ -65,36 +64,34 @@ impl GenerateCode for SolidityMetadata<'_> {
 }
 
 impl SolidityMetadata<'_> {
-    /// Generates Solidity ABI compatible metadata for default or first ink! constructor.
-    fn constructor(&self) -> TokenStream2 {
-        let ctor = self
-            .contract
+    /// Generates Solidity ABI compatible metadata for all ink! constructors.
+    fn constructors(&self) -> impl Iterator<Item = TokenStream2> + '_ {
+        self.contract
             .module()
             .impls()
             .flat_map(|item_impl| item_impl.iter_constructors())
-            .find_or_first(|ctor| ctor.is_default())
-            .expect("Expected at least one constructor");
-
-        let ident = ctor.ident();
-        let name = ident.to_string();
-        let inputs = params_info(ctor.inputs());
-        let is_payable = ctor.is_payable();
-        let is_default = ctor.is_default();
-        let docs = extract_docs(ctor.attrs());
+            .map(|ctor| {
+                let ident = ctor.ident();
+                let name = ident.to_string();
+                let inputs = params_info(ctor.inputs());
+                let is_payable = ctor.is_payable();
+                let is_default = ctor.is_default();
+                let docs = extract_docs(ctor.attrs());
 
-        quote! {
-            ::ink::metadata::sol::ConstructorMetadata {
-                name: #name,
-                inputs: vec![ #( #inputs ),* ],
-                is_payable: #is_payable,
-                is_default: #is_default,
-                docs: #docs,
-            }
-        }
+                quote! {
+                    ::ink::metadata::sol::ConstructorMetadata {
+                        name: #name.into(),
+                        inputs: vec![ #( #inputs ),* ],
+                        is_payable: #is_payable,
+                        is_default: #is_default,
+                        docs: #docs.into(),
+                    }
+                }
+            })
     }
 
     /// Generates Solidity ABI compatible metadata for all ink! messages.
-    fn messages(&self) -> Vec<TokenStream2> {
+    fn messages(&self) -> impl Iterator<Item = TokenStream2> + '_ {
         self.contract
             .module()
             .impls()
@@ -107,7 +104,7 @@ impl SolidityMetadata<'_> {
                     .output()
                     .map(|ty| {
                         let sol_ty = sol_type(ty);
-                        quote! { ::core::option::Option::Some(#sol_ty) }
+                        quote! { ::core::option::Option::Some(#sol_ty.into()) }
                     })
                     .unwrap_or_else(|| {
                         quote! { ::core::option::Option::None }
@@ -119,37 +116,34 @@ impl SolidityMetadata<'_> {
 
                 quote! {
                     ::ink::metadata::sol::FunctionMetadata {
-                        name: #name,
+                        name: #name.into(),
                         inputs: vec![ #( #inputs ),* ],
                         output: #output,
                         mutates: #mutates,
                         is_payable: #is_payable,
                         is_default: #is_default,
-                        docs: #docs,
+                        docs: #docs.into(),
                     }
                 }
             })
-            .collect()
     }
 }
 
 /// Returns the Solidity ABI compatible parameter type and name for the given inputs.
-fn params_info(inputs: InputsIter) -> Vec<TokenStream2> {
-    inputs
-        .map(|input| {
-            let ty = &*input.ty;
-            let sol_ty = sol_type(ty);
-            let ident = match &*input.pat {
-                Pat::Ident(ident) => &ident.ident,
-                _ => unreachable!("Expected an input identifier"),
-            };
-            let name = ident.to_string();
-            quote! {
-                ::ink::metadata::sol::ParamMetadata {
-                    name: #name,
-                    ty: #sol_ty,
-                }
+fn params_info(inputs: InputsIter) -> impl Iterator<Item = TokenStream2> + '_ {
+    inputs.map(|input| {
+        let ty = &*input.ty;
+        let sol_ty = sol_type(ty);
+        let ident = match &*input.pat {
+            Pat::Ident(ident) => &ident.ident,
+            _ => unreachable!("Expected an input identifier"),
+        };
+        let name = ident.to_string();
+        quote! {
+            ::ink::metadata::sol::ParamMetadata {
+                name: #name.into(),
+                ty: #sol_ty.into(),
             }
-        })
-        .collect()
+        }
+    })
 }

crates/metadata/src/sol.rs

@@ -12,7 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-//! Types for representing Solidity ABI compatible metadata for ink! projects.
+//! Types for representing Solidity ABI compatibility metadata for ink! projects.
+
+use std::borrow::Cow;
 
 use serde::{
     Deserialize,
@@ -23,82 +25,82 @@ use serde::{
 #[derive(Debug, Serialize, Deserialize)]
 pub struct ContractMetadata {
     /// Name of ink! contract.
-    pub name: &'static str,
-    /// Metadata for default or first constructor of ink! contract.
-    pub constructor: ConstructorMetadata,
+    pub name: Cow<'static, str>,
+    /// Metadata for all constructors of ink! contract.
+    pub constructors: Vec<ConstructorMetadata>,
     /// Metadata for all messages of ink! contract.
     pub functions: Vec<FunctionMetadata>,
     /// Metadata for all events of ink! contract.
     pub events: Vec<EventMetadata>,
     /// Documentation for ink! contract.
-    pub docs: &'static str,
+    pub docs: Cow<'static, str>,
 }
 
 /// ink! constructor info for Solidity ABI compatible metadata generation.
 #[derive(Debug, Serialize, Deserialize)]
 pub struct ConstructorMetadata {
     /// Name of ink! constructor.
-    pub name: &'static str,
+    pub name: Cow<'static, str>,
     /// Parameter info for ink! constructor.
     pub inputs: Vec<ParamMetadata>,
     /// Whether the ink! constructor is marked as payable.
     pub is_payable: bool,
     /// Whether the ink! constructor is marked as default.
     pub is_default: bool,
     /// Documentation for ink! constructor.
-    pub docs: &'static str,
+    pub docs: Cow<'static, str>,
 }
 
 /// ink! message info for Solidity ABI compatible metadata generation.
 #[derive(Debug, Serialize, Deserialize)]
 pub struct FunctionMetadata {
     /// Name of ink! message.
-    pub name: &'static str,
+    pub name: Cow<'static, str>,
     /// Parameter info for ink! message.
     pub inputs: Vec<ParamMetadata>,
     /// Return type of ink! message.
-    pub output: Option<&'static str>,
+    pub output: Option<Cow<'static, str>>,
     /// Whether the ink! message has a mutable self receiver.
     pub mutates: bool,
     /// Whether the ink! message is marked as payable.
     pub is_payable: bool,
     /// Whether the ink! message is marked as default.
     pub is_default: bool,
     /// Documentation for ink! message.
-    pub docs: &'static str,
+    pub docs: Cow<'static, str>,
 }
 
 /// ink! event info for Solidity ABI compatible metadata generation.
 #[derive(Debug, Serialize, Deserialize)]
 pub struct EventMetadata {
     /// Name of ink! event.
-    pub name: &'static str,
+    pub name: Cow<'static, str>,
     /// Whether the ink! event is marked as anonymous.
     pub is_anonymous: bool,
     /// Parameter info for ink! event.
     pub params: Vec<EventParamMetadata>,
     /// Documentation for ink! event.
-    pub docs: &'static str,
+    pub docs: Cow<'static, str>,
 }
 
 /// ink! constructor and message parameter info.
 #[derive(Debug, Serialize, Deserialize)]
 pub struct ParamMetadata {
     /// Name of parameter.
-    pub name: &'static str,
+    pub name: Cow<'static, str>,
     /// Solidity ABI type of parameter.
-    pub ty: &'static str,
+    pub ty: Cow<'static, str>,
 }
 
 /// ink! event parameter info.
 #[derive(Debug, Serialize, Deserialize)]
 pub struct EventParamMetadata {
     /// Name of parameter.
-    pub name: &'static str,
+    pub name: Cow<'static, str>,
     /// Solidity ABI type of parameter.
-    pub ty: &'static str,
+    pub ty: Cow<'static, str>,
     /// Whether the parameter is marked as a topic (i.e. is indexed).
     pub is_topic: bool,
     /// Documentation for parameter.
-    pub docs: &'static str,
+    pub docs: Cow<'static, str>,
 }