Refactor contract ref generation and add automatic re-exporting (#2710)

* codegen: Only generate contract refs in test, std or dependency mode

* codegen: Automatically re-export contract refs in test, std or dependency mode

* codegen: Implement `::ink::codegen::ContractCallBuilder` for contract refs

* codegen: Implement `::ink::codegen::ContractCallBuilder` for call forwarder

* tests: Fix integration tests that re-export contract refs

* docs: Fix doc tests that re-export contract refs

* Update changelog

* make `contract_ref` attribute type alias `pub`

Author: davidsemakula

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 [Unreleased]
 
+### Changed
+
+- Refactor contract ref generation and add automatic re-exporting - [#2710](https://github.com/use-ink/ink/pull/2710)
+
 ## Version 6.0.0-beta
 
 ### Added

crates/env/src/call/create_builder.rs

@@ -387,7 +387,7 @@ where
 /// #         pub fn message(&self) {}
 /// #     }
 /// # }
-/// # use contract::MyContractRef;
+/// #
 /// let my_contract: MyContractRef = build_create::<MyContractRef>()
 ///     .code_hash(ink::H256::from([0x42; 32]))
 ///     .endowment(25.into())
@@ -431,7 +431,7 @@ where
 /// #         pub fn message(&self) {}
 /// #     }
 /// # }
-/// # use contract::{MyContractRef, ConstructorError};
+/// # use contract::ConstructorError;
 /// let my_contract: MyContractRef = build_create::<MyContractRef>()
 ///     .code_hash(ink::H256::from([0x42; 32]))
 ///     .endowment(25.into())

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

@@ -52,6 +52,7 @@ impl GenerateCode for CallBuilder<'_> {
         let call_builder_impls = self.generate_call_forwarder_impls();
         let call_builder_inherent_impls = self.generate_call_builder_inherent_impls();
         quote! {
+            #[cfg(any(test, feature = "std", feature = "ink-as-dependency"))]
             const _: () = {
                 #call_builder_struct
                 #auxiliary_trait_impls
@@ -124,6 +125,7 @@ impl CallBuilder<'_> {
                 _marker: core::marker::PhantomData<Abi>,
             }
 
+            #[cfg(any(test, feature = "std", feature = "ink-as-dependency"))]
             const _: () = {
                 impl ::ink::codegen::ContractCallBuilder for #storage_ident {
                     type Type<Abi> = #cb_ident<Abi>;

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

@@ -56,11 +56,16 @@ impl GenerateCode for ContractRef<'_> {
         let call_builder_trait_impl = self.generate_call_builder_trait_impl();
         let auxiliary_trait_impls = self.generate_auxiliary_trait_impls();
         quote! {
+            #[cfg(any(test, feature = "std", feature = "ink-as-dependency"))]
             #contract_ref
-            #contract_ref_trait_impls
-            #contract_ref_inherent_impls
-            #call_builder_trait_impl
-            #auxiliary_trait_impls
+
+            #[cfg(any(test, feature = "std", feature = "ink-as-dependency"))]
+            const _: () = {
+                #contract_ref_trait_impls
+                #contract_ref_inherent_impls
+                #call_builder_trait_impl
+                #auxiliary_trait_impls
+            };
         }
     }
 }
@@ -104,6 +109,7 @@ impl ContractRef<'_> {
             let ref_ident_abi_alias = format_ident!("{ref_ident_default_abi}{suffix}");
             quote! {
                 #[allow(dead_code)]
+                #[cfg(any(test, feature = "std", feature = "ink-as-dependency"))]
                 pub type #ref_ident_abi_alias = #ref_ident::<#abi_ty>;
             }
         });
@@ -152,10 +158,12 @@ impl ContractRef<'_> {
 
             // Default type alias (i.e. `ContractRef` for a contract named `Contract`).
             #[allow(dead_code)]
+            #[cfg(any(test, feature = "std", feature = "ink-as-dependency"))]
             pub type #ref_ident_default_abi = #ref_ident::<#abi>;
             // ABI specific type aliases (i.e. `ContractRefInk` and `ContractRefSol`) as appropriate.
             #ref_ident_abi_aliases
 
+            #[cfg(any(test, feature = "std", feature = "ink-as-dependency"))]
             const _: () = {
                 impl ::ink::env::ContractReference for #storage_ident {
                     type Type = #ref_ident;
@@ -309,6 +317,10 @@ impl ContractRef<'_> {
                         &mut self.inner
                     }
                 }
+
+                impl<TypeAbi> ::ink::codegen::ContractCallBuilder for #ref_ident<TypeAbi> {
+                    type Type<TraitAbi> = <#storage_ident as ::ink::codegen::ContractCallBuilder>::Type<TypeAbi>;
+                }
             };
         )
     }

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

@@ -60,7 +60,14 @@ impl GenerateCode for Contract<'_> {
         #[cfg(any(ink_abi = "sol", ink_abi = "all"))]
         let solidity_metadata = self.generate_code_using::<generator::SolidityMetadata>();
 
+        let contract_ref_base_ident =
+            quote::format_ident!("{}Ref", module.storage().ident());
+
         quote! {
+            // Note: rustdoc can't resolve `self::` prefixes for this re-export.
+            #[cfg(any(test, feature = "std", feature = "ink-as-dependency"))]
+            pub use #ident::#contract_ref_base_ident;
+
             #( #attrs )*
             #vis mod #ident {
                 #env

crates/ink/codegen/src/generator/trait_def/call_forwarder.rs

@@ -354,6 +354,13 @@ impl CallForwarder<'_> {
                     &mut self.builder
                 }
             }
+
+            impl<E, TypeAbi> ::ink::codegen::ContractCallBuilder for #call_forwarder_ident<E, TypeAbi>
+            where
+                E: ::ink::env::Environment,
+            {
+                type Type<TraitAbi> = #call_builder_ident<E, TypeAbi>;
+            }
         )
     }
 

crates/ink/macro/src/contract_ref.rs

@@ -68,7 +68,7 @@ pub fn analyze_or_err(
         #trait_def_impl
 
         // Type alias for contract ref.
-        type #contract_ref_name =
+        pub type #contract_ref_name =
             <<::ink::reflect::TraitDefinitionRegistry<#env> as #trait_name>
                     ::__ink_TraitInfo as ::ink::codegen::TraitCallForwarder>::Forwarder<#abi_ty>;
     ))

crates/primitives/src/contract.rs

@@ -139,10 +139,7 @@ pub trait ContractEnv {
 ///     }
 /// }
 ///
-/// use contract::{
-///     Contract,
-///     ContractRef,
-/// };
+/// use contract::Contract;
 /// # use ink::codegen::utils::IsSameType;
 /// # use ink::env::ContractReference;
 ///

integration-tests/internal/lang-err/call-builder/lib.rs

@@ -171,10 +171,7 @@ mod call_builder {
             ChainBackend,
             ContractsBackend,
         };
-        use integration_flipper::{
-            Flipper,
-            FlipperRef,
-        };
+        use integration_flipper::FlipperRef;
 
         type E2EResult<T> = std::result::Result<T, Box<dyn std::error::Error>>;
 
@@ -200,7 +197,7 @@ mod call_builder {
                 .submit()
                 .await
                 .expect("instantiate `flipper` failed");
-            let flipper_call = flipper.call_builder::<Flipper>();
+            let flipper_call = flipper.call_builder::<FlipperRef>();
 
             let flipper_get = flipper_call.get();
             let get_call_result = client.call(&origin, &flipper_get).dry_run().await?;

integration-tests/internal/lang-err/constructors-return-value/lib.rs

@@ -1,10 +1,6 @@
 #![cfg_attr(not(feature = "std"), no_std, no_main)]
 
-pub use self::constructors_return_value::{
-    ConstructorError,
-    ConstructorsReturnValue,
-    ConstructorsReturnValueRef,
-};
+pub use self::constructors_return_value::ConstructorError;
 
 #[ink::contract]
 pub mod constructors_return_value {