Support ABI cfg flag in codegen (#2501)

* Use `ink_abi` `cfg` flag for ABI detection

* Remove `abi` config arg from ink! contract attribute macro

* tests: Update integration tests for `sol` ABI

* chore: Derive `Copy` for ABI enum

* ci: Use `cargo contract test` for contract integration tests

* Update `contract-build` version

* tests: Update ui tests for `sol` and `all` ABI

* Update changelog

* docs: Remove `abi` config arg from ink! contract attribute macro

* docs: `trybuild` wrapper motivation

* docs: lint suppression

* fix: Remove deprecated `--skip-linting` flag from contract build calls

* Update `Cargo.lock`

* ci: separate job for Solidity ABI integration tests

* tests: move Solidity ABI integration tests and refactor CI

* Reuse `rustc` wrapper across contract builds in e2e tests

Author: davidsemakula

.github/workflows/ci.yml

@@ -556,9 +556,11 @@ jobs:
         with:
           # Run all tests with --all-features, which will run the `e2e-tests` feature if present.
           command: |
-            scripts/for_all_contracts_exec.sh --path integration-tests --ignore internal/static-buffer --ignore internal/mapping \
-            --ignore public/debugging-strategies --ignore public/wildcard-selector --partition ${{ matrix.partition }}/4 -- \
-            cargo test --all-features --manifest-path {}
+            scripts/for_all_contracts_exec.sh --path integration-tests --ignore internal/static-buffer \
+            --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 --partition ${{ matrix.partition }}/4 -- \
+            cargo contract test --all-features --manifest-path {}
 
   examples-test-mapping:
     runs-on: ubuntu-latest
@@ -585,7 +587,7 @@ jobs:
               INK_STATIC_BUFFER_SIZE: 256
           with:
             command: |
-                cargo test --all-features --manifest-path integration-tests/internal/mapping/Cargo.toml
+                cargo contract test --all-features --manifest-path integration-tests/internal/mapping/Cargo.toml
 
   # TODO: (@davidsemakula) Add back to `examples-test` job when flakiness is fixed.
   examples-test-debugging-strategies:
@@ -608,7 +610,7 @@ jobs:
         uses: ./.github/run-container-command
         with:
           command: |
-            cargo test --all-features --manifest-path integration-tests/public/debugging-strategies/Cargo.toml
+            cargo contract test --all-features --manifest-path integration-tests/public/debugging-strategies/Cargo.toml
 
 
   # TODO: (@davidsemakula) Add back to `examples-test` job when flakiness is fixed.
@@ -632,7 +634,7 @@ jobs:
         uses: ./.github/run-container-command
         with:
           command: |
-            cargo test --all-features --manifest-path integration-tests/public/wildcard-selector/Cargo.toml
+            cargo contract test --all-features --manifest-path integration-tests/public/wildcard-selector/Cargo.toml
 
   examples-custom-test:
     runs-on: ubuntu-latest
@@ -666,7 +668,7 @@ jobs:
               --manifest-path integration-tests/public/flipper/Cargo.toml \
               --suri //Alice --args true -x -y --output-json | \
               jq -r .contract | xargs subkey inspect | grep -o "0x.*" | head -n1)
-            CONTRACTS_NODE_URL=ws://127.0.0.1:9944 cargo test \
+            CONTRACTS_NODE_URL=ws://127.0.0.1:9944 cargo contract test \
               --features e2e-tests \
               --manifest-path integration-tests/public/flipper/Cargo.toml \
               e2e_test_deployed_contract \
@@ -684,7 +686,32 @@ jobs:
             # the readme + test comments explain why `32`, in short because the tests write
             # content into the buffer and want to provoke an exhaustion of the buffer.
             cargo clean --manifest-path integration-tests/internal/static-buffer/Cargo.toml
-            INK_STATIC_BUFFER_SIZE=32 cargo test --manifest-path integration-tests/internal/static-buffer/Cargo.toml --all-features
+            INK_STATIC_BUFFER_SIZE=32 cargo contract test --manifest-path integration-tests/internal/static-buffer/Cargo.toml --all-features
+
+  # NOTE: Sharing build artifacts (i.e. via a shared cargo target directory) with other tests
+  # that don't have the `ink_abi="sol"` `cfg` option set makes the Solidity ABI tests fail.
+  examples-test-solidity-abi:
+    runs-on: ubuntu-latest
+    needs: ci-image
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Initialize runner
+        uses: ./.github/init
+        with:
+          cache: true
+          cache-directories: ${{ github.workspace }}/${{ env.CARGO_TARGET_DIR }}
+          cache-on-failure: true
+
+      - name: Test Solidity ABI Examples
+        uses: ./.github/run-container-command
+        with:
+          command: |
+            scripts/for_all_contracts_exec.sh --path integration-tests/solidity-abi -- \
+            cargo contract test --all-features --manifest-path {}
 
   examples-contract-build-riscv:
     runs-on: ubuntu-latest

CHANGELOG.md

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

Cargo.lock

@@ -38,7 +38,7 @@ array-init = { version = "2.0", default-features = false }
 blake2 = { version = "0.10" }
 cargo_metadata = { version = "0.19.0" }
 cfg-if = { version = "1.0" }
-contract-build = { version = "6.0.0-alpha" }
+contract-build = { version = "6.0.0-alpha.1", git = "https://github.com/use-ink/cargo-contract", branch = "master" }
 darling = { version = "0.20.11" }
 derive_more = { version = "2.0.1", default-features = false }
 either = { version = "1.13", default-features = false }

Cargo.toml

@@ -12,21 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use crate::log_info;
-use contract_build::{
-    BuildArtifacts,
-    BuildMode,
-    ExecuteArgs,
-    Features,
-    ImageVariant,
-    ManifestPath,
-    MetadataSpec,
-    Network,
-    OutputType,
-    UnstableFlags,
-    Verbosity,
-};
-use itertools::Itertools;
 use std::{
     collections::{
         hash_map::Entry,
@@ -43,13 +28,43 @@ use std::{
     },
 };
 
+use contract_build::{
+    package_abi,
+    util::rustc_wrapper,
+    Abi,
+    BuildArtifacts,
+    BuildMode,
+    ExecuteArgs,
+    Features,
+    ImageVariant,
+    ManifestPath,
+    MetadataSpec,
+    Network,
+    OutputType,
+    UnstableFlags,
+    Verbosity,
+};
+use itertools::Itertools;
+
+use crate::log_info;
+
 /// Builds the "root" contract (the contract in which the E2E tests are defined) together
 /// with any contracts which are a dependency of the root contract.
 ///
 /// todo explain features
 pub fn build_root_and_contract_dependencies(features: Vec<String>) -> Vec<PathBuf> {
     let contract_project = ContractProject::new();
     let contract_manifests = contract_project.root_with_contract_dependencies();
+    if contract_project.package_abi.is_some() {
+        // Generates a custom `rustc` wrapper which passes compiler flags to `rustc`,
+        // because `cargo` doesn't pass compiler flags to proc macros and build
+        // scripts when the `--target` flag is set.
+        // See `contract_build::util::rustc_wrapper::generate` docs for details.
+        if let Ok(rustc_wrapper) = rustc_wrapper::generate(&contract_project.target_dir) {
+            // SAFETY: The `rustc` wrapper is safe to reuse across all threads.
+            env::set_var("INK_RUSTC_WRAPPER", rustc_wrapper);
+        }
+    }
     build_contracts(&contract_manifests, features)
 }
 
@@ -58,15 +73,18 @@ pub fn build_root_and_contract_dependencies(features: Vec<String>) -> Vec<PathBu
 struct ContractProject {
     root_package: Option<PathBuf>,
     contract_dependencies: Vec<PathBuf>,
+    package_abi: Option<Abi>,
+    target_dir: PathBuf,
 }
 
 impl ContractProject {
     fn new() -> Self {
         let mut cmd = cargo_metadata::MetadataCommand::new();
-        if let Some(target_dir) = env::var_os("CARGO_TARGET_DIR")
-            .filter(|target_dir| Path::new(&target_dir).is_absolute())
-        {
-            cmd.env("CARGO_TARGET_DIR", &target_dir);
+        let env_target_dir = env::var_os("CARGO_TARGET_DIR")
+            .map(|target_dir| PathBuf::from(target_dir))
+            .filter(|target_dir| target_dir.is_absolute());
+        if let Some(target_dir) = env_target_dir.as_ref() {
+            cmd.env("CARGO_TARGET_DIR", target_dir);
         }
         let metadata = cmd
             .exec()
@@ -102,14 +120,26 @@ impl ContractProject {
             .iter()
             .filter_map(maybe_contract_package)
             .collect();
-
         log_info(&format!(
             "found those contract dependencies: {:?}",
             contract_dependencies
         ));
+
+        let package_abi = metadata
+            .root_package()
+            .and_then(|package| package_abi(package))
+            .and_then(Result::ok);
+        log_info(&format!("found root package abi: {:?}", package_abi));
+
+        let target_dir = env_target_dir
+            .unwrap_or_else(|| metadata.target_directory.into_std_path_buf());
+        log_info(&format!("found target dir: {:?}", target_dir));
+
         Self {
             root_package,
             contract_dependencies,
+            package_abi,
+            target_dir,
         }
     }
 

crates/e2e/src/contract_build.rs

@@ -48,9 +48,11 @@ std = [
     "derive_more/std"
 ]
 
-# For the ui tests, which use this `Cargo.toml`
 [lints.rust.unexpected_cfgs]
 level = "warn"
 check-cfg = [
+    # For the ui tests, which use this `Cargo.toml`
     'cfg(feature, values(any()))',
+    # For ABI declaration.
+    'cfg(ink_abi, values("ink", "sol", "all"))'
 ]