Add contract's ink! compatibility check

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add `--binary` flag for `info` command - [#1311](https://github.com/paritytech/cargo-contract/pull/1311/)
 - Add `--all` flag for `info` command - [#1319](https://github.com/paritytech/cargo-contract/pull/1319)
 - Fix for a Url to String conversion in `info` command - [#1330](https://github.com/paritytech/cargo-contract/pull/1330)
+- Add warning message when using incompatible contract's ink! version [#1334](https://github.com/paritytech/cargo-contract/pull/1334)
 
 ## [4.0.0-alpha]
 

crates/build/src/crate_metadata.rs

@@ -117,7 +117,7 @@ impl CrateMetadata {
             .packages
             .iter()
             .find_map(|package| {
-                if package.name == "ink" {
+                if package.name == "ink" || package.name == "ink_lang" {
                     Some(
                         Version::parse(&package.version.to_string())
                             .expect("Invalid ink crate version string"),

crates/build/src/lib.rs

@@ -17,7 +17,10 @@
 #![doc = include_str!("../README.md")]
 #![deny(unused_crate_dependencies)]
 
-use contract_metadata::ContractMetadata;
+use contract_metadata::{
+    compatibility::check_contract_ink_compatibility,
+    ContractMetadata,
+};
 use which as _;
 
 mod args;
@@ -855,6 +858,10 @@ pub fn execute(args: ExecuteArgs) -> Result<BuildResult> {
         assert_debug_mode_supported(&crate_metadata.ink_version)?;
     }
 
+    if let Err(e) = check_contract_ink_compatibility(&crate_metadata.ink_version) {
+        eprintln!("{} {}", "warning:".yellow().bold(), e.to_string().bold());
+    }
+
     let clean_metadata = || {
         fs::remove_file(crate_metadata.metadata_path()).ok();
         fs::remove_file(crate_metadata.contract_bundle_path()).ok();

crates/extrinsics/src/lib.rs

@@ -28,6 +28,7 @@ mod upload;
 #[cfg(feature = "integration-tests")]
 mod integration_tests;
 
+use colored::Colorize;
 use subxt::utils::AccountId32;
 
 use anyhow::{
@@ -195,6 +196,12 @@ impl ContractArtifacts {
                     )
                 }
             };
+
+        if let Some(contract_metadata) = metadata.as_ref() {
+            if let Err(e) = contract_metadata.check_ink_compatibility() {
+                eprintln!("{} {}", "warning:".yellow().bold(), e.to_string().bold());
+            }
+        }
         Ok(Self {
             artifacts_path: path.into(),
             metadata_path,

crates/metadata/compatibility_list.json

@@ -0,0 +1,10 @@
+{
+    "cargo-contract": {
+        "1.5.0": {
+            "ink": [">=3.0.0,<4.0.0", ">=3.0.0-alpha, <4.0.0-alpha.3"]
+        },
+        "4.0.0-alpha": {
+            "ink": ["4.0.0-alpha.3", "4.0.0", "5.0.0-alpha"]
+        }
+    }
+}

crates/metadata/src/compatibility.rs

@@ -0,0 +1,161 @@
+// Copyright 2018-2023 Parity Technologies (UK) Ltd.
+// This file is part of cargo-contract.
+//
+// cargo-contract is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// cargo-contract is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with cargo-contract.  If not, see <http://www.gnu.org/licenses/>.
+
+use std::collections::HashMap;
+
+use anyhow::{
+    anyhow,
+    bail,
+    Result,
+};
+use semver::{
+    Version,
+    VersionReq,
+};
+
+/// Version of the currently executing `cargo-contract` binary.
+const VERSION: &str = env!("CARGO_PKG_VERSION");
+
+#[derive(Debug, serde::Deserialize)]
+struct Compatibility {
+    #[serde(rename = "cargo-contract")]
+    cargo_contract_compatibility: HashMap<Version, Requirements>,
+}
+
+#[derive(Debug, serde::Deserialize)]
+struct Requirements {
+    #[serde(rename = "ink")]
+    ink_requirements: Vec<VersionReq>,
+}
+
+/// Checks whether the contract's ink! version is compatible with the cargo-contract
+/// binary.
+pub fn check_contract_ink_compatibility(ink_version: &Version) -> Result<()> {
+    let compatibility_list = include_str!("../compatibility_list.json");
+    let compatibility: Compatibility = serde_json::from_str(compatibility_list)?;
+    let cargo_contract_version =
+        semver::Version::parse(VERSION).expect("Parsing version failed");
+    let ink_req = &compatibility
+        .cargo_contract_compatibility
+        .get(&cargo_contract_version)
+        .ok_or(anyhow!(
+            "Missing compatibility configuration for cargo-contract: {}",
+            cargo_contract_version
+        ))?
+        .ink_requirements;
+
+    // Check if the ink! version matches any of the requirement
+    if !ink_req.iter().any(|req| req.matches(ink_version)) {
+        // Get matching ink! versions
+        let ink_matches = ink_req
+            .iter()
+            .map(|req| format!("'{}'", req))
+            .collect::<Vec<_>>()
+            .join(", ");
+
+        let ink_matches_message = if !ink_matches.is_empty() {
+            format!("update the contract ink! to a version of {}", ink_matches)
+        } else {
+            String::default()
+        };
+
+        // Find best cargo-contract version
+        let cargo_contract_match_message = compatibility
+            .cargo_contract_compatibility
+            .iter()
+            .filter_map(|(ver, reqs)| {
+                if reqs
+                    .ink_requirements
+                    .iter()
+                    .any(|req| req.matches(ink_version))
+                {
+                    return Some(ver)
+                }
+                None
+            })
+            .max_by(|&a, &b| {
+                match (!a.pre.is_empty(), !b.pre.is_empty()) {
+                    (false, true) => std::cmp::Ordering::Greater,
+                    (true, false) => std::cmp::Ordering::Less,
+                    (_, _) => a.cmp(b),
+                }
+            })
+            .map(|ver| format!("update the cargo-contract to version '{}'", ver))
+            .unwrap_or_default();
+
+        let matches_message = [cargo_contract_match_message, ink_matches_message]
+            .into_iter()
+            .filter(|m| !m.is_empty())
+            .collect::<Vec<_>>()
+            .join(" or ");
+        if !matches_message.is_empty() {
+            return Err(anyhow!(
+                "The cargo-contract is not compatible with the contract's ink! version. Please {}",
+                 matches_message
+            ))
+        } else {
+            bail!(
+                "The cargo-contract is not compatible with the contract's ink! version, \
+                but a matching version could not be found"
+            )
+        }
+    }
+    Ok(())
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use pretty_assertions::assert_eq;
+
+    #[test]
+    fn ink_check_failes_when_incompatible_version() {
+        let ink_version = Version::new(3, 2, 0);
+        let res = check_contract_ink_compatibility(&ink_version)
+            .expect_err("Ink version check should fail");
+
+        assert_eq!(
+            res.to_string(),
+            "The cargo-contract is not compatible with the contract's ink! version. \
+            Please update the cargo-contract to version '1.5.0' or \
+            update the contract ink! to a version of '^4.0.0-alpha.3', '^4.0.0', '^5.0.0-alpha'"
+        );
+
+        let ink_version =
+            Version::parse("4.0.0-alpha.1").expect("Parsing version must work");
+        let res = check_contract_ink_compatibility(&ink_version)
+            .expect_err("Ink version check should fail");
+
+        assert_eq!(
+                res.to_string(),
+                "The cargo-contract is not compatible with the contract's ink! version. \
+                Please update the cargo-contract to version '1.5.0' or \
+                update the contract ink! to a version of '^4.0.0-alpha.3', '^4.0.0', '^5.0.0-alpha'"
+        );
+    }
+
+    #[test]
+    fn ink_check_succeeds_when_compatible_version() {
+        let ink_version = Version::new(4, 2, 3);
+        let res = check_contract_ink_compatibility(&ink_version);
+        assert!(res.is_ok());
+
+        let ink_version =
+            Version::parse("4.0.0-alpha.4").expect("Parsing version must work");
+        let res = check_contract_ink_compatibility(&ink_version);
+        assert!(res.is_ok());
+    }
+}

crates/metadata/src/lib.rs

@@ -67,6 +67,7 @@
 #![deny(unused_crate_dependencies)]
 
 mod byte_str;
+pub mod compatibility;
 
 use anyhow::{
     Context,
@@ -148,6 +149,17 @@ impl ContractMetadata {
             path.display()
         ))
     }
+
+    /// Checks whether the contract's ink! version is compatible with the cargo-contract
+    /// binary
+    pub fn check_ink_compatibility(&self) -> Result<()> {
+        if let Language::Ink = self.source.language.language {
+            compatibility::check_contract_ink_compatibility(
+                &self.source.language.version,
+            )?;
+        }
+        Ok(())
+    }
 }
 
 /// Representation of the Wasm code hash.