Item name/identifier overrides for overloading, selector computation and metadata (#2577)

* ir: Add `sol_name` to ink! message and event

* codegen: Use `sol_name` (if provided) for Solidity message selectors and metadata

* codegen: Use `sol_name` (if provided) for Solidity event metadata

* tests: UI tests for `sol_name` attribute argument

* tests: Ensure `sol_name` is used in Solidity metadata

* Update changelog

* fmt

* Update changelog

* Generalize `name` override attribute argument
- Rename from `sol_name` to `name`
- Allow use for ink! ABI

* tests: Refactor `name` override UI tests

* Use `name` overrides for message and constructor selector computation

* tests: UI tests for `name` override message and constructor selectors

* Use `name` overrides for message and constructor metadata

* tests: UI tests for `name` override message and constructor metadata

* Update changelog

* ir: Improve signature topic parsing and validation

* ir: Re-usable event config parsing and validation

* Use `name` overrides for event signature topic computation and metadata

* chore: rename signature topic utilities

* chore: rename `sol_name` to `name`

Author: davidsemakula

CHANGELOG.md

@@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Improve handling of Solidity constructor return and revert data - [#2552](https://github.com/use-ink/ink/pull/2552)
 - Implement `SolEncode` and `SolDecode` for `Option<T>` - [#2545](https://github.com/use-ink/ink/pull/2545)
 - Allow writing E2E fuzz tests for contracts - [#2570](https://github.com/use-ink/ink/pull/2570)
+- Item name/identifier overrides for overloading, selector computation and metadata - [#2577](https://github.com/use-ink/ink/pull/2577)
 
 ### Changed
 - Use marker trait for finding ink! storage `struct` during code analysis - [2499](https://github.com/use-ink/ink/pull/2499)

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

@@ -42,8 +42,14 @@ impl GenerateCode for Event<'_> {
             .then(|| quote::quote! { #[ink(anonymous)] });
         let signature_topic = self
             .item
-            .signature_topic_hex()
+            .signature_topic()
+            .as_ref()
+            .map(ToString::to_string)
             .map(|hex_s| quote::quote! { #[ink(signature_topic = #hex_s)] });
+        let name_override = self
+            .item
+            .name()
+            .map(|name| quote::quote! { #[ink(name = #name)] });
         let cfg_attrs = self.item.get_cfg_attrs(item.span());
 
         #[cfg(all(feature = "std", any(ink_abi = "sol", ink_abi = "all")))]
@@ -59,6 +65,7 @@ impl GenerateCode for Event<'_> {
             #[::ink::scale_derive(Encode, Decode)]
             #anonymous
             #signature_topic
+            #name_override
             #item
 
             #sol_event_metadata
@@ -72,7 +79,11 @@ impl Event<'_> {
     fn solidity_event_metadata(&self) -> TokenStream2 {
         let item = self.item.item();
         let ident = &item.ident;
-        let name = ident.to_string();
+        let name = self
+            .item
+            .name()
+            .map(ToString::to_string)
+            .unwrap_or_else(|| ident.to_string());
         let is_anonymous = self.item.anonymous();
 
         let fields = match &item.fields {

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

@@ -150,14 +150,17 @@ impl Metadata<'_> {
         let is_payable = constructor.is_payable();
         let is_default = constructor.is_default();
         let constructor = constructor.callable();
-        let ident = constructor.ident();
+        let name = constructor
+            .name()
+            .map(ToString::to_string)
+            .unwrap_or_else(|| constructor.ident().to_string());
         let args = constructor.inputs().map(Self::generate_dispatch_argument);
         let storage_ident = self.contract.module().storage().ident();
         let ret_ty = Self::generate_constructor_return_type(storage_ident, selector_id);
         let cfg_attrs = constructor.get_cfg_attrs(span);
         quote_spanned!(span=>
             #( #cfg_attrs )*
-            ::ink::metadata::ConstructorSpec::from_label(::core::stringify!(#ident))
+            ::ink::metadata::ConstructorSpec::from_label(#name)
                 .selector([
                     #( #selector_bytes ),*
                 ])
@@ -215,14 +218,17 @@ impl Metadata<'_> {
                 let is_default = message.is_default();
                 let message = message.callable();
                 let mutates = message.receiver().is_ref_mut();
-                let ident = message.ident();
+                let name = message
+                    .name()
+                    .map(ToString::to_string)
+                    .unwrap_or_else(|| message.ident().to_string());
                 let args = message.inputs().map(Self::generate_dispatch_argument);
                 let cfg_attrs = message.get_cfg_attrs(span);
                 let ret_ty =
                     Self::generate_message_return_type(&message.wrapped_output());
                 quote_spanned!(span =>
                     #( #cfg_attrs )*
-                    ::ink::metadata::MessageSpec::from_label(::core::stringify!(#ident))
+                    ::ink::metadata::MessageSpec::from_label(#name)
                         .selector([
                             #( #selector_bytes ),*
                         ])
@@ -261,7 +267,10 @@ impl Metadata<'_> {
             .flatten()
             .map(|((trait_ident, trait_path), message)| {
                 let message_span = message.span();
-                let message_ident = message.ident();
+                let message_name = message
+                    .name()
+                    .map(ToString::to_string)
+                    .unwrap_or_else(|| message.ident().to_string());
                 let message_docs = message
                     .attrs()
                     .iter()
@@ -283,7 +292,7 @@ impl Metadata<'_> {
                         as ::ink::reflect::TraitMessageInfo<#local_id>>::SELECTOR
                 }};
                 let ret_ty = Self::generate_message_return_type(&message.wrapped_output());
-                let label = [trait_ident.to_string(), message_ident.to_string()].join("::");
+                let label = [trait_ident.to_string(), message_name].join("::");
                 quote_spanned!(message_span=>
                     #( #cfg_attrs )*
                     ::ink::metadata::MessageSpec::from_label(#label)

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

@@ -72,8 +72,10 @@ impl SolidityMetadata<'_> {
             .impls()
             .flat_map(|item_impl| item_impl.iter_constructors())
             .map(|ctor| {
-                let ident = ctor.ident();
-                let name = ident.to_string();
+                let name = ctor
+                    .name()
+                    .map(ToString::to_string)
+                    .unwrap_or_else(|| ctor.ident().to_string());
                 let inputs = params_info(ctor.inputs());
                 let is_payable = ctor.is_payable();
                 let is_default = ctor.is_default();
@@ -98,8 +100,10 @@ impl SolidityMetadata<'_> {
             .impls()
             .flat_map(|item_impl| item_impl.iter_messages())
             .map(|msg| {
-                let ident = msg.ident();
-                let name = ident.to_string();
+                let name = msg
+                    .name()
+                    .map(ToString::to_string)
+                    .unwrap_or_else(|| msg.ident().to_string());
                 let inputs = params_info(msg.inputs());
                 let output = msg
                     .output()

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

@@ -51,7 +51,11 @@ pub fn sol_return_type(ty: &Type) -> TokenStream2 {
 
 /// Returns Solidity ABI compatible selector of an ink! message.
 pub fn selector(message: &Message) -> TokenStream2 {
-    let signature = call_signature(message.ident().to_string(), message.inputs());
+    let name = message
+        .name()
+        .map(ToString::to_string)
+        .unwrap_or_else(|| message.ident().to_string());
+    let signature = call_signature(name, message.inputs());
     quote! {
         const {
             ::ink::codegen::sol::selector_bytes(#signature)

crates/ink/ir/src/ast/meta.rs

@@ -178,7 +178,7 @@ impl MetaValue {
     }
 
     /// Returns the value of the literal if it is a string literal.
-    pub fn as_string(&self) -> Option<String> {
+    pub fn to_string(&self) -> Option<String> {
         match self {
             Self::Lit(syn::Lit::Str(lit_str)) => Some(lit_str.value()),
             _ => None,