Improve Solidity ABI support in codegen, ink_env and ink_e2e (#2517)

* codegen: Solidity ABI support for trait definitions

* codegen: Refactor CallBuilder generation

* codegen: Refactor dispatchable message info

* codegen: Solidity ABI support for trait message guards

* tests: Add `trait-flipper` to Solidity ABI integration tests

* tests: Add `trait-dyn-cross-contract-calls` to Solidity ABI integration tests

* e2e: Solidity ABI support for call result decoding

* codegen: Disable ink! metadata generator for Solidity ABI only contracts

* ci: Update `examples-test` job

* codegen: Refactor Solidity selector utilities

* ci: Silence unexpected `ink_abi` `cfg` warnings for `clippy-examples` and `examples-docs` jobs

* ir: Remove unused ABI enum

* docs: Encoding types

* env: Add `build_call_abi`

* codegen: ABI specific contract refs, call builders and message builders

* e2e: call builder utilities

* Update changelog

* style: Refactor ABI types

* tests: Update ui test output

* codegen: input and output guards for Solidity ABI

* docs: Update `contract_ref!` and `message_builder!` docs and examples

* ci: Update `clippy-examples` and `examples-contract-build-riscv`

* env: Use the "default" for `build_call` utility

* docs: "default" ABI for calls

* codegen: Ensure Solidity selector and selector ids are always computed at compile time

* docs: `build_call_abi` rustdoc formatting

* primitives: Standard trait derives for ABI type

* chore: Remove unnecessary lint suppression

* primitives: Solidity ABI encode/decode for function params

* env: Fix `SolEncode` implementation for `ArgumentList`

* codegen: Use `SolParamsDecode` trait for parameter decoding

Author: davidsemakula

.github/workflows/ci.yml

@@ -172,6 +172,10 @@ jobs:
       fail-fast: false
       matrix:
         type: [STD, RISCV]
+    env:
+      # TODO: (@davidsemakula) Update all manifests for integration-tests and remove this
+      # i.e. update with equivalent of setting `--check-cfg cfg(ink_abi,values("ink","sol","all"))`
+      ALLOWED_LINTS: -A unexpected_cfgs
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -191,7 +195,7 @@ jobs:
         with:
           command: |
             scripts/for_all_contracts_exec.sh --path integration-tests -- cargo clippy --all-targets \
-              --manifest-path {} -- -D warnings -A $CLIPPY_ALLOWED
+              --manifest-path {} -- -D warnings -A $CLIPPY_ALLOWED $ALLOWED_LINTS
 
       - name: Run Clippy for RISC-V Examples
         uses: ./.github/run-container-command
@@ -200,7 +204,7 @@ jobs:
           command: |
             scripts/for_all_contracts_exec.sh --path integration-tests -- cargo clippy --no-default-features \
               --target ${CLIPPY_TARGET} \
-              --manifest-path {} -- -D warnings -A $CLIPPY_ALLOWED
+              --manifest-path {} -- -D warnings -A $CLIPPY_ALLOWED $ALLOWED_LINTS
 
   check:
     runs-on: ubuntu-latest
@@ -560,6 +564,7 @@ jobs:
             --ignore internal/mapping --ignore public/debugging-strategies --ignore public/wildcard-selector \
             --ignore solidity-abi/sol-cross-contract --ignore solidity-abi/sol-encoding \
             --ignore solidity-abi/solidity-calls-flipper --ignore solidity-abi/events \
+            --ignore solidity-abi/trait-flipper --ignore solidity-abi/trait-dyn-cross-contract-calls \
             --partition ${{ matrix.partition }}/4 -- \
             cargo contract test --all-features --manifest-path {}
 
@@ -741,19 +746,36 @@ jobs:
       - name: Build Contract Examples for RISC-V
         uses: ./.github/run-container-command
         env:
-          RUSTC_BOOTSTRAP: 1
           MANIFEST_PATH: ""
           CONTRACT_SIZE_FILE: "measurements-${{ env.MEASUREMENTS_ID }}/contract_size_"
           CARGO_INCREMENTAL: 0
         with:
           command: |
             mkdir -p measurements-${{ env.MEASUREMENTS_ID }}/
-            scripts/for_all_contracts_exec2.sh --path integration-tests -- \
+            scripts/for_all_contracts_exec2.sh --path integration-tests \
+              --ignore solidity-abi/sol-cross-contract --ignore solidity-abi/sol-encoding \
+              --ignore solidity-abi/solidity-calls-flipper --ignore solidity-abi/events \
+              --ignore solidity-abi/trait-flipper --ignore solidity-abi/trait-dyn-cross-contract-calls -- \
               scripts/build_and_determine_contract_size.sh {}
   
           #bash -c "scripts/build_and_determine_contract_size.sh {} >> ${CONTRACT_SIZE_FILE} && \
           #sed -ie 's/^integration-tests\/\(public\/\|internal\/\)\?//' ${CONTRACT_SIZE_FILE}"
 
+      # NOTE: Sharing build artifacts (i.e. via a shared cargo target directory) with other contracts
+      # that don't have the same ABI set makes the builds fail.
+      - name: Build Contract Examples for RISC-V (Solidity ABI)
+        uses: ./.github/run-container-command
+        env:
+          MANIFEST_PATH: ""
+          CONTRACT_SIZE_FILE: "measurements-${{ env.MEASUREMENTS_ID }}/contract_size_"
+          CARGO_INCREMENTAL: 0
+          CARGO_TARGET_DIR: ${{ env.CARGO_TARGET_DIR }}/sol-abi
+        with:
+          command: |
+            mkdir -p measurements-${{ env.MEASUREMENTS_ID }}/
+            scripts/for_all_contracts_exec2.sh --path integration-tests/solidity-abi -- \
+              scripts/build_and_determine_contract_size.sh {}
+
       - uses: actions/upload-artifact@v4
         with:
             path: ./measurements-${{ env.MEASUREMENTS_ID }}/*
@@ -805,7 +827,8 @@ jobs:
       - name: Create Examples Docs
         uses: ./.github/run-container-command
         env:
-          RUSTDOCFLAGS:                  -Dwarnings
+          # TODO: (@davidsemakula) Update all manifests for integration-tests and remove `--check-cfg` flag
+          RUSTDOCFLAGS: -Dwarnings --check-cfg cfg(ink_abi,values("ink","sol","all"))
         with:
           command: |
             # `--document-private-items` needs to be in here because currently our contract macro

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Support ABI `cfg` flag in codegen - [#2501](https://github.com/use-ink/ink/pull/2501)
 - Generate Solidity ABI compatibility metadata - [#2510](https://github.com/use-ink/ink/pull/2510)
+- Improve Solidity ABI support in `codegen`, `ink_env` and `ink_e2e` - [#2517](https://github.com/use-ink/ink/pull/2517)
 
 ### Changed
 - Use marker trait for finding ink! storage `struct` during code analysis - [2499](https://github.com/use-ink/ink/pull/2499)

crates/e2e/src/backend.rs

@@ -12,6 +12,23 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+use ink_env::{
+    DefaultEnvironment,
+    Environment,
+};
+use ink_primitives::{
+    abi::{
+        AbiDecodeWith,
+        AbiEncodeWith,
+        Ink,
+    },
+    DepositLimit,
+};
+use jsonrpsee::core::async_trait;
+use pallet_revive::evm::CallTrace;
+use sp_weights::Weight;
+use subxt::dynamic::Value;
+
 use super::{
     InstantiateDryRunResult,
     Keypair,
@@ -30,22 +47,6 @@ use crate::{
     CallDryRunResult,
     UploadResult,
 };
-use ink_env::{
-    DefaultEnvironment,
-    Environment,
-};
-use ink_primitives::{
-    reflect::{
-        AbiDecodeWith,
-        AbiEncodeWith,
-        ScaleEncoding,
-    },
-    DepositLimit,
-};
-use jsonrpsee::core::async_trait;
-use pallet_revive::evm::CallTrace;
-use sp_weights::Weight;
-use subxt::dynamic::Value;
 
 /// Full E2E testing backend: combines general chain API and contract-specific operations.
 #[async_trait]
@@ -134,7 +135,7 @@ pub trait ContractsBackend<E: Environment> {
     fn instantiate<
         'a,
         Contract: Clone,
-        Args: Send + Clone + AbiEncodeWith<ScaleEncoding> + Sync,
+        Args: Send + Clone + AbiEncodeWith<Ink> + Sync,
         R,
     >(
         &'a mut self,
@@ -271,7 +272,7 @@ pub trait BuilderClient<E: Environment>: ContractsBackend<E> {
         message: &CallBuilderFinal<E, Args, RetType, Abi>,
         value: E::Balance,
         storage_deposit_limit: DepositLimit<E::Balance>,
-    ) -> Result<CallDryRunResult<E, RetType>, Self::Error>
+    ) -> Result<CallDryRunResult<E, RetType, Abi>, Self::Error>
     where
         CallBuilderFinal<E, Args, RetType, Abi>: Clone;
 
@@ -311,7 +312,7 @@ pub trait BuilderClient<E: Environment>: ContractsBackend<E> {
     /// instance is reused!
     async fn bare_instantiate<
         Contract: Clone,
-        Args: Send + Sync + AbiEncodeWith<ScaleEncoding> + Clone,
+        Args: Send + Sync + AbiEncodeWith<Ink> + Clone,
         R,
     >(
         &mut self,
@@ -326,7 +327,7 @@ pub trait BuilderClient<E: Environment>: ContractsBackend<E> {
     /// Dry run contract instantiation.
     async fn bare_instantiate_dry_run<
         Contract: Clone,
-        Args: Send + Sync + AbiEncodeWith<ScaleEncoding> + Clone,
+        Args: Send + Sync + AbiEncodeWith<Ink> + Clone,
         R,
     >(
         &mut self,

crates/e2e/src/backend_calls.rs

@@ -12,6 +12,19 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+use std::marker::PhantomData;
+
+use ink_env::Environment;
+use ink_primitives::{
+    abi::{
+        AbiDecodeWith,
+        AbiEncodeWith,
+        Ink,
+    },
+    DepositLimit,
+};
+use sp_weights::Weight;
+
 use super::{
     balance_to_deposit_limit,
     InstantiateDryRunResult,
@@ -28,25 +41,13 @@ use crate::{
     UploadResult,
     H256,
 };
-use ink_env::Environment;
-use ink_primitives::{
-    reflect::{
-        AbiDecodeWith,
-        AbiEncodeWith,
-        ScaleEncoding,
-    },
-    DepositLimit,
-};
-use sp_weights::Weight;
-use std::marker::PhantomData;
 
 /// Allows to build an end-to-end call using a builder pattern.
 pub struct CallBuilder<'a, E, Args, RetType, B, Abi>
 where
     E: Environment,
     Args: AbiEncodeWith<Abi> + Clone,
     RetType: Send + AbiDecodeWith<Abi>,
-
     B: BuilderClient<E>,
     Abi: Clone,
 {
@@ -141,7 +142,7 @@ where
     /// to add a margin to the gas limit.
     pub async fn submit(
         &mut self,
-    ) -> Result<CallResult<E, RetType, B::EventLog>, B::Error>
+    ) -> Result<CallResult<E, RetType, B::EventLog, Abi>, B::Error>
     where
         CallBuilderFinal<E, Args, RetType, Abi>: Clone,
     {
@@ -184,7 +185,7 @@ where
     }
 
     /// Dry run the call.
-    pub async fn dry_run(&mut self) -> Result<CallDryRunResult<E, RetType>, B::Error>
+    pub async fn dry_run(&mut self) -> Result<CallDryRunResult<E, RetType, Abi>, B::Error>
     where
         CallBuilderFinal<E, Args, RetType, Abi>: Clone,
     {
@@ -203,7 +204,7 @@ where
 pub struct InstantiateBuilder<'a, E, Contract, Args, R, B>
 where
     E: Environment,
-    Args: AbiEncodeWith<ScaleEncoding> + Clone,
+    Args: AbiEncodeWith<Ink> + Clone,
     Contract: Clone,
 
     B: ContractsBackend<E>,
@@ -221,7 +222,7 @@ where
 impl<'a, E, Contract, Args, R, B> InstantiateBuilder<'a, E, Contract, Args, R, B>
 where
     E: Environment,
-    Args: AbiEncodeWith<ScaleEncoding> + Clone + Send + Sync,
+    Args: AbiEncodeWith<Ink> + Clone + Send + Sync,
     Contract: Clone,
     B: BuilderClient<E>,
 {

crates/e2e/src/builders.rs

@@ -12,7 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use crate::H256;
 use ink_env::{
     call::{
         utils::{
@@ -25,23 +24,25 @@ use ink_env::{
     },
     Environment,
 };
-use ink_primitives::reflect::{
+use ink_primitives::abi::{
     AbiEncodeWith,
-    ScaleEncoding,
+    Ink,
 };
 
+use crate::H256;
+
 /// The type returned from `ContractRef` constructors, partially initialized with the
 /// execution input arguments.
 pub type CreateBuilderPartial<E, ContractRef, Args, R> = CreateBuilder<
     E,
     ContractRef,
     Set<LimitParamsV2>,
-    Set<ExecutionInput<Args, ScaleEncoding>>,
+    Set<ExecutionInput<Args, Ink>>,
     Set<ReturnType<R>>,
 >;
 
 /// Get the encoded constructor arguments from the partially initialized `CreateBuilder`
-pub fn constructor_exec_input<E, ContractRef, Args: AbiEncodeWith<ScaleEncoding>, R>(
+pub fn constructor_exec_input<E, ContractRef, Args: AbiEncodeWith<Ink>, R>(
     builder: CreateBuilderPartial<E, ContractRef, Args, R>,
 ) -> Vec<u8>
 where