Refactor multi ABI interfaces (#2618)

* env: multi ABI interface for call and create builders

* ink: multi ABI interface for emit emission for `EnvAccess`

* codegen: multi ABI interface for contract refs

* tests: Update integration tests

* tests: Update ui tests

* chore: clippy

* Update changelog

* docs

Co-authored-by: Michael Müller <[email protected]>

---------

Co-authored-by: Michael Müller <[email protected]>

Author: davidsemakula

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Synchronize with `polkadot-sdk/c40b36c3a7c208f9a6837b80812473af3d9ba7f7` ‒ [2589](https://github.com/use-ink/ink/pull/2589)
 - Synchronize with `polkadot-sdk/a71ec19a94702ea71767ba5ac97603ea6c6305c1` ‒ [2619](https://github.com/use-ink/ink/pull/2619)
+- Refactor multi ABI interfaces - [#2618](https://github.com/use-ink/ink/pull/2618)
 
 ### Removed
 - Removed functionalities around calling into the runtime and chain extensions ‒ [2621](https://github.com/use-ink/ink/pull/2621)

crates/env/src/call/call_builder/mod.rs

@@ -21,7 +21,10 @@ pub use delegate::DelegateCall;
 use core::marker::PhantomData;
 
 use ink_primitives::{
-    abi::Sol,
+    abi::{
+        Ink,
+        Sol,
+    },
     Address,
 };
 
@@ -232,14 +235,15 @@ where
     }
 }
 
-/// Returns a new [`CallBuilder`] for the specified ABI to build up the parameters to a
-/// cross-contract call.
+/// Returns a new [`CallBuilder`] to build up the parameters to a cross-contract call
+/// that uses ink! ABI Encoding (i.e. with SCALE codec for input/output encode/decode).
+///
 /// See [`build_call`] for more details on usage.
 #[allow(clippy::type_complexity)]
-pub fn build_call_abi<E, Abi>() -> CallBuilder<
+pub fn build_call_ink<E>() -> CallBuilder<
     E,
     Unset<Call>,
-    Unset<ExecutionInput<EmptyArgumentList<Abi>, Abi>>,
+    Unset<ExecutionInput<EmptyArgumentList<Ink>, Ink>>,
     Unset<ReturnType<()>>,
 >
 where
@@ -255,9 +259,10 @@ where
 
 /// Returns a new [`CallBuilder`] to build up the parameters to a cross-contract call
 /// that uses Solidity ABI Encoding.
+///
 /// See [`build_call`] for more details on usage.
 #[allow(clippy::type_complexity)]
-pub fn build_call_solidity<E>() -> CallBuilder<
+pub fn build_call_sol<E>() -> CallBuilder<
     E,
     Unset<Call>,
     Unset<ExecutionInput<EmptyArgumentList<Sol>, Sol>>,

crates/env/src/call/create_builder.rs

@@ -17,6 +17,7 @@ use core::marker::PhantomData;
 use ink_primitives::{
     abi::{
         AbiEncodeWith,
+        Ink,
         Sol,
     },
     Address,
@@ -472,17 +473,19 @@ where
     }
 }
 
-/// Returns a new [`CreateBuilder`] for the specified ABI to build up the parameters to a
-/// cross-contract instantiation.
+/// Returns a new [`CreateBuilder`] to build up the parameters to a cross-contract
+/// instantiation that uses ink! ABI Encoding (i.e. with SCALE codec for input/output
+/// encode/decode).
+///
 /// See [`build_create`] for more details on usage.
 #[allow(clippy::type_complexity)]
-pub fn build_create_abi<ContractRef, Abi>() -> CreateBuilder<
+pub fn build_create_ink<ContractRef>() -> CreateBuilder<
     <ContractRef as ContractEnv>::Env,
     ContractRef,
     Set<LimitParamsV2>,
-    Unset<ExecutionInput<EmptyArgumentList<Abi>, Abi>>,
+    Unset<ExecutionInput<EmptyArgumentList<Ink>, Ink>>,
     Unset<ReturnType<()>>,
-    Abi,
+    Ink,
 >
 where
     ContractRef: ContractEnv,
@@ -504,9 +507,10 @@ where
 
 /// Returns a new [`CreateBuilder`] to build up the parameters to a cross-contract
 /// instantiation that uses Solidity ABI Encoding.
+///
 /// See [`build_create`] for more details on usage.
 #[allow(clippy::type_complexity)]
-pub fn build_create_solidity<ContractRef>() -> CreateBuilder<
+pub fn build_create_sol<ContractRef>() -> CreateBuilder<
     <ContractRef as ContractEnv>::Env,
     ContractRef,
     Set<LimitParamsV2>,

crates/env/src/call/mod.rs

@@ -45,17 +45,17 @@ pub mod utils {
 pub use self::{
     call_builder::{
         build_call,
-        build_call_abi,
-        build_call_solidity,
+        build_call_ink,
+        build_call_sol,
         Call,
         CallBuilder,
         CallParams,
         DelegateCall,
     },
     create_builder::{
         build_create,
-        build_create_abi,
-        build_create_solidity,
+        build_create_ink,
+        build_create_sol,
         state,
         ConstructorReturnType,
         CreateBuilder,

crates/ink/codegen/src/generator/as_dependency/call_builder.rs

@@ -452,13 +452,23 @@ impl CallBuilder<'_> {
             .map(quote::ToTokens::to_token_stream)
             .unwrap_or_else(|| quote::quote! { () });
         let output_span = return_type.span();
-        let (selector_bytes, abi_ty) = match abi {
+        let (selector_bytes, abi_ty, build_call_fn) = match abi {
             Abi::Ink => {
                 let selector = message.composed_selector();
                 let selector_bytes = selector.hex_lits();
-                (quote!([ #( #selector_bytes ),* ]), quote!(::ink::abi::Ink))
+                (
+                    quote!([ #( #selector_bytes ),* ]),
+                    quote!(::ink::abi::Ink),
+                    quote!(build_call_ink),
+                )
+            }
+            Abi::Sol => {
+                (
+                    sol::utils::selector(&message),
+                    quote!(::ink::abi::Sol),
+                    quote!(build_call_sol),
+                )
             }
-            Abi::Sol => (sol::utils::selector(&message), quote!(::ink::abi::Sol)),
         };
         let arg_list = generator::generate_argument_list(
             input_types.iter().cloned(),
@@ -480,7 +490,7 @@ impl CallBuilder<'_> {
                 & #mut_tok self
                 #( , #input_bindings : #input_types )*
             ) -> #output_type {
-                ::ink::env::call::build_call_abi::<Environment, #abi_ty>()
+                ::ink::env::call::#build_call_fn::<Environment>()
                     .call(::ink::ToAddr::to_addr(self))
                     .exec_input(
                         ::ink::env::call::ExecutionInput::new(

crates/ink/codegen/src/generator/as_dependency/contract_ref.rs

@@ -21,6 +21,7 @@ use ir::{
 use itertools::Itertools;
 use proc_macro2::TokenStream as TokenStream2;
 use quote::{
+    format_ident,
     quote,
     quote_spanned,
 };
@@ -65,9 +66,14 @@ impl GenerateCode for ContractRef<'_> {
 }
 
 impl ContractRef<'_> {
+    /// Generates the identifier of the contract reference struct.
+    fn generate_contract_ref_base_ident(&self) -> syn::Ident {
+        format_ident!("{}Ref", self.contract.module().storage().ident())
+    }
+
     /// Generates the identifier of the contract reference struct.
     fn generate_contract_ref_ident(&self) -> syn::Ident {
-        quote::format_ident!("{}Ref", self.contract.module().storage().ident())
+        format_ident!("{}For", self.generate_contract_ref_base_ident())
     }
 
     /// Generates the code for the struct representing the contract reference.
@@ -89,6 +95,18 @@ impl ContractRef<'_> {
         let storage_ident = self.contract.module().storage().ident();
         let ref_ident = self.generate_contract_ref_ident();
         let abi = default_abi!();
+        let ref_ident_default_abi = self.generate_contract_ref_base_ident();
+        let ref_ident_abi_aliases = generate_abi_impls!(@type |abi| {
+            let (abi_ty, suffix) = match abi {
+                Abi::Ink => (quote!(::ink::abi::Ink), "Ink"),
+                Abi::Sol => (quote!(::ink::abi::Sol), "Sol"),
+            };
+            let ref_ident_abi_alias = format_ident!("{ref_ident_default_abi}{suffix}");
+            quote! {
+                #[allow(dead_code)]
+                pub type #ref_ident_abi_alias = #ref_ident::<#abi_ty>;
+            }
+        });
         let sol_codec = if cfg!(any(ink_abi = "sol", ink_abi = "all")) {
             // These manual implementations are a bit more efficient than the derived
             // equivalents.
@@ -132,6 +150,12 @@ impl ContractRef<'_> {
                 _marker: core::marker::PhantomData<Abi>,
             }
 
+            // Default type alias (i.e. `ContractRef` for a contract named `Contract`).
+            #[allow(dead_code)]
+            pub type #ref_ident_default_abi = #ref_ident::<#abi>;
+            // ABI specific type aliases (i.e. `ContractRefInk` and `ContractRefSol`) as appropriate.
+            #ref_ident_abi_aliases
+
             const _: () = {
                 impl ::ink::env::ContractReference for #storage_ident {
                     type Type = #ref_ident;
@@ -585,7 +609,7 @@ impl ContractRef<'_> {
             .map(quote::ToTokens::to_token_stream)
             .unwrap_or_else(|| quote::quote! { Self });
 
-        let (abi_ty, exec_input_init) = match abi {
+        let (abi_ty, exec_input_init, build_create_fn) = match abi {
             Abi::Ink => {
                 let selector_bytes = constructor.composed_selector().hex_lits();
                 (
@@ -595,6 +619,7 @@ impl ContractRef<'_> {
                             ::ink::env::call::Selector::new([ #( #selector_bytes ),* ])
                         )
                     },
+                    quote!(build_create_ink),
                 )
             }
             Abi::Sol => {
@@ -603,6 +628,7 @@ impl ContractRef<'_> {
                     quote! {
                         ::ink::env::call::ExecutionInput::no_selector()
                     },
+                    quote!(build_create_sol),
                 )
             }
         };
@@ -625,7 +651,7 @@ impl ContractRef<'_> {
                 ::ink::env::call::utils::Set<::ink::env::call::utils::ReturnType<#ret_type>>,
                 #abi_ty
             > {
-                ::ink::env::call::build_create_abi::<Self, #abi_ty>()
+                ::ink::env::call::#build_create_fn::<Self>()
                     .exec_input(
                         #exec_input_init
                         #(

crates/ink/src/env_access.rs

@@ -31,10 +31,13 @@ use ink_env::{
     },
     Environment,
     Result,
-    TopicEncoder,
 };
 use ink_primitives::{
-    abi::AbiEncodeWith,
+    abi::{
+        AbiEncodeWith,
+        Ink,
+        Sol,
+    },
     Address,
     H256,
     U256,
@@ -408,13 +411,21 @@ where
         ink_env::emit_event::<E, Evt, crate::abi::Sol>(&event);
     }
 
-    /// Emits an event using the specified ABI.
-    pub fn emit_event_abi<Evt, Abi>(self, event: Evt)
+    /// Emits an event using the ink! ABI encoding (i.e. with SCALE codec for event data
+    /// encode/decode).
+    pub fn emit_event_ink<Evt>(self, event: Evt)
+    where
+        Evt: ink_env::Event<Ink>,
+    {
+        ink_env::emit_event::<E, Evt, Ink>(&event)
+    }
+
+    /// Emits an event using the Solidity ABI encoding.
+    pub fn emit_event_sol<Evt>(self, event: Evt)
     where
-        Evt: ink_env::Event<Abi>,
-        Abi: TopicEncoder,
+        Evt: ink_env::Event<Sol>,
     {
-        ink_env::emit_event::<E, Evt, Abi>(&event)
+        ink_env::emit_event::<E, Evt, Sol>(&event)
     }
 
     /// Instantiates another contract using the supplied code hash.

crates/ink/tests/ui/contract/fail/constructor/constructor-return-result-invalid.stderr

@@ -18,11 +18,11 @@ error[E0276]: impl has stricter requirements than trait
 18 | |         }
    | |_________^ impl has extra requirement `ConstructorOutputValue<Result<u8, contract::Error>>: ConstructorOutput<contract::Contract>`
 
-error[E0277]: the trait bound `Result<u8, contract::Error>: ConstructorReturnType<ContractRef, ink::abi::Ink>` is not satisfied
+error[E0277]: the trait bound `Result<u8, contract::Error>: ConstructorReturnType<ContractRefFor, ink::abi::Ink>` is not satisfied
   --> tests/ui/contract/fail/constructor/constructor-return-result-invalid.rs:16:33
    |
 16 |           pub fn constructor() -> Result<u8, Error> {
-   |           -                       ^^^^^^^^^^^^^^^^^ the trait `ConstructorReturnType<ContractRef, ink::abi::Ink>` is not implemented for `Result<u8, contract::Error>`
+   |           -                       ^^^^^^^^^^^^^^^^^ the trait `ConstructorReturnType<ContractRefFor, ink::abi::Ink>` is not implemented for `Result<u8, contract::Error>`
    |  _________|
    | |
 17 | |             Ok(5_u8)
@@ -31,7 +31,7 @@ error[E0277]: the trait bound `Result<u8, contract::Error>: ConstructorReturnTyp
    |
    = help: the following other types implement trait `ConstructorReturnType<C, Abi>`:
              `Result<C, E>` implements `ConstructorReturnType<C, Abi>`
-             `Result<contract::Contract, E>` implements `ConstructorReturnType<ContractRef, Abi>`
+             `Result<contract::Contract, E>` implements `ConstructorReturnType<ContractRefFor, Abi>`
 note: required by a bound in `CreateBuilder::<E, ContractRef, Limits, Args, Unset<ReturnType<()>>, Abi>::returns`
   --> $WORKSPACE/crates/env/src/call/create_builder.rs
    |

crates/ink/tests/ui/contract/fail/constructor/constructor-return-result-non-codec-error.stderr

@@ -34,7 +34,7 @@ error[E0277]: the trait bound `contract::Error: WrapperTypeDecode` is not satisf
              sp_core::Bytes
    = note: required for `contract::Error` to implement `ink::parity_scale_codec::Decode`
    = note: required for `contract::Error` to implement `DecodeConstructorError<ink::abi::Ink>`
-   = note: required for `Result<ContractRef, contract::Error>` to implement `ConstructorReturnType<ContractRef, ink::abi::Ink>`
+   = note: required for `Result<ContractRefFor, contract::Error>` to implement `ConstructorReturnType<ContractRefFor, ink::abi::Ink>`
 note: required by a bound in `CreateBuilder::<E, ContractRef, Limits, Args, Unset<ReturnType<()>>, Abi>::returns`
   --> $WORKSPACE/crates/env/src/call/create_builder.rs
    |

integration-tests/all-abi/events/lib.rs

@@ -424,7 +424,7 @@ pub mod events {
         ) -> E2EResult<()> {
             // given
             let init_value = false;
-            let mut constructor = EventsRef::<ink::abi::Ink>::new(init_value);
+            let mut constructor = EventsRef::new(init_value);
             let contract = client
                 .instantiate("events", &ink_e2e::alice(), &mut constructor)
                 .submit()
@@ -487,7 +487,7 @@ pub mod events {
         ) -> E2EResult<()> {
             // given
             let init_value = false;
-            let mut constructor = EventsRef::<ink::abi::Ink>::new(init_value);
+            let mut constructor = EventsRef::new(init_value);
             let contract = client
                 .instantiate("events", &ink_e2e::alice(), &mut constructor)
                 .submit()
@@ -574,7 +574,7 @@ pub mod events {
         ) -> E2EResult<()> {
             // given
             let init_value = false;
-            let mut constructor = EventsRef::<ink::abi::Ink>::new(init_value);
+            let mut constructor = EventsRef::new(init_value);
             let contract = client
                 .instantiate("events", &ink_e2e::alice(), &mut constructor)
                 .submit()
@@ -649,7 +649,7 @@ pub mod events {
         ) -> E2EResult<()> {
             // given
             let init_value = false;
-            let mut constructor = EventsRef::<ink::abi::Ink>::new(init_value);
+            let mut constructor = EventsRef::new(init_value);
             let contract = client
                 .instantiate("events", &ink_e2e::alice(), &mut constructor)
                 .submit()