[CLI] Add a CLI command to install prover dependencies

Cargo.toml

@@ -744,6 +744,7 @@ serde-generate = { git = "https://github.com/aptos-labs/serde-reflection", rev =
 serde-reflection = { git = "https://github.com/aptos-labs/serde-reflection", rev = "73b6bbf748334b71ff6d7d09d06a29e3062ca075" }
 serde_with = "3.4.0"
 serde_yaml = "0.8.24"
+set_env = "1.3.4"
 shadow-rs = "0.16.2"
 simplelog = "0.9.0"
 smallbitvec = "2.5.1"

crates/aptos/CHANGELOG.md

@@ -4,6 +4,8 @@ All notable changes to the Aptos CLI will be captured in this file. This project
 
 ## Unreleased
 - `aptos move fmt` formats move files inside the `tests` and `examples` directory of a package.
+- Add `aptos update prover-dependencies`, which installs the dependency of Move prover, boogie, z3 and cvc5.
+- Update the default version of `movefmt` to be installed from 1.0.4 to 1.0.5
 
 ## [4.2.3] - 2024/09/20
 - Fix the broken indexer in localnet in 4.2.2, which migrates table info from sycn to async ways.

crates/aptos/Cargo.toml

@@ -78,6 +78,7 @@ move-disassembler = { workspace = true }
 move-ir-types = { workspace = true }
 move-model = { workspace = true }
 move-package = { workspace = true }
+move-prover-boogie-backend = { workspace = true }
 move-symbol-pool = { workspace = true }
 move-unit-test = { workspace = true, features = ["debugging"] }
 move-vm-runtime = { workspace = true, features = ["testing"] }
@@ -94,6 +95,7 @@ serde = { workspace = true }
 serde_json = { workspace = true }
 serde_yaml = { workspace = true }
 server-framework = { git = "https://github.com/aptos-labs/aptos-indexer-processors.git", rev = "51a34901b40d7f75767ac907b4d2478104d6a515" }
+set_env = { workspace = true }
 tempfile = { workspace = true }
 thiserror = { workspace = true }
 tokio = { workspace = true }

crates/aptos/src/update/aptos.rs

@@ -49,8 +49,8 @@ impl BinaryUpdater for AptosUpdateTool {
         self.check
     }
 
-    fn pretty_name(&self) -> &'static str {
-        "Aptos CLI"
+    fn pretty_name(&self) -> String {
+        "Aptos CLI".to_string()
     }
 
     /// Return information about whether an update is required.

crates/aptos/src/update/mod.rs

@@ -7,6 +7,8 @@
 mod aptos;
 mod helpers;
 mod movefmt;
+mod prover_dependencies;
+mod prover_dependency_installer;
 mod revela;
 mod tool;
 mod update_helper;
@@ -25,7 +27,7 @@ trait BinaryUpdater {
     fn check(&self) -> bool;
 
     /// Only used for messages we print to the user.
-    fn pretty_name(&self) -> &'static str;
+    fn pretty_name(&self) -> String;
 
     /// Return information about whether an update is required.
     fn get_update_info(&self) -> Result<UpdateRequiredInfo>;

crates/aptos/src/update/movefmt.rs

@@ -13,7 +13,7 @@ use self_update::update::ReleaseUpdate;
 use std::path::PathBuf;
 
 const FORMATTER_BINARY_NAME: &str = "movefmt";
-const TARGET_FORMATTER_VERSION: &str = "1.0.4";
+const TARGET_FORMATTER_VERSION: &str = "1.0.5";
 
 const FORMATTER_EXE_ENV: &str = "FORMATTER_EXE";
 #[cfg(target_os = "windows")]
@@ -64,8 +64,8 @@ impl BinaryUpdater for FormatterUpdateTool {
         self.check
     }
 
-    fn pretty_name(&self) -> &'static str {
-        "movefmt"
+    fn pretty_name(&self) -> String {
+        "movefmt".to_string()
     }
 
     /// Return information about whether an update is required.
@@ -127,5 +127,6 @@ pub fn get_movefmt_path() -> Result<PathBuf> {
         FORMATTER_EXE_ENV,
         FORMATTER_BINARY_NAME,
         FORMATTER_EXE,
+        true,
     )
 }

crates/aptos/src/update/prover_dependencies.rs

@@ -0,0 +1,213 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+use crate::{
+    cli_build_information,
+    common::types::{CliCommand, CliError, CliTypedResult},
+    update::{
+        get_additional_binaries_dir, prover_dependency_installer::DependencyInstaller,
+        update_binary,
+    },
+};
+use anyhow::{Context, Result};
+use aptos_build_info::BUILD_OS;
+use async_trait::async_trait;
+use clap::Parser;
+use move_prover_boogie_backend::options::{
+    BoogieOptions, MAX_BOOGIE_VERSION, MAX_CVC5_VERSION, MAX_Z3_VERSION, MIN_BOOGIE_VERSION,
+    MIN_CVC5_VERSION, MIN_Z3_VERSION,
+};
+use std::{
+    env,
+    path::{Path, PathBuf},
+};
+
+pub(crate) const REPO_NAME: &str = "prover-dependency";
+pub(crate) const REPO_OWNER: &str = "aptos-labs";
+
+pub(crate) const BOOGIE_BINARY_NAME: &str = "boogie";
+pub(crate) const TARGET_BOOGIE_VERSION: &str = "3.2.4";
+
+pub(crate) const BOOGIE_EXE_ENV: &str = "BOOGIE_EXE";
+#[cfg(target_os = "windows")]
+pub(crate) const BOOGIE_EXE: &str = "boogie.exe";
+#[cfg(not(target_os = "windows"))]
+pub(crate) const BOOGIE_EXE: &str = "boogie";
+
+const Z3_BINARY_NAME: &str = "z3";
+const TARGET_Z3_VERSION: &str = "4.11.2";
+
+const Z3_EXE_ENV: &str = "Z3_EXE";
+#[cfg(target_os = "windows")]
+const Z3_EXE: &str = "z3.exe";
+#[cfg(not(target_os = "windows"))]
+const Z3_EXE: &str = "z3";
+
+const CVC5_BINARY_NAME: &str = "cvc5";
+const TARGET_CVC5_VERSION: &str = "0.0.3";
+
+const CVC5_EXE_ENV: &str = "CVC5_EXE";
+#[cfg(target_os = "windows")]
+const CVC5_EXE: &str = "cvc5.exe";
+#[cfg(not(target_os = "windows"))]
+const CVC5_EXE: &str = "cvc5";
+
+/// Install dependencies (boogie, z3 and cvc5) for Move prover
+#[derive(Debug, Parser)]
+pub struct ProverDependencyInstaller {
+    /// Where to install binaries of boogie, z3 and cvc5. If not
+    /// given we will put it in a standard location for your OS.
+    #[clap(long)]
+    install_dir: Option<PathBuf>,
+}
+
+impl ProverDependencyInstaller {
+    fn add_env_var(&self, env_var: &str, install_path: &Path) -> Result<(), CliError> {
+        if let Ok(current_value) = env::var(env_var) {
+            if current_value == install_path.to_string_lossy() {
+                return Ok(());
+            } else {
+                return Err(CliError::UnexpectedError(format!(
+                    "{} is already set to a different value: {}.",
+                    env_var, current_value
+                )));
+            }
+        }
+
+        set_env::set(env_var, install_path.to_string_lossy())
+            .map_err(|e| CliError::UnexpectedError(format!("Failed to set {}: {}", env_var, e)))?;
+        println!(
+            "Added {} to environment with value: {} to the profile.",
+            env_var,
+            install_path.to_string_lossy()
+        );
+        if env::var(env_var).is_err() {
+            eprintln!("Please use the `source` command or reboot the terminal to check whether {} is set with the correct value. \
+            If not, please set it manually.", env_var);
+        }
+        Ok(())
+    }
+
+    async fn download_dependency(&self) -> CliTypedResult<String> {
+        let build_info = cli_build_information();
+        let _ = match build_info.get(BUILD_OS).context("Failed to determine build info of current CLI")?.as_str() {
+            "linux-x86_64" => Ok("linux"),
+            "macos-aarch64" | "macos-x86_64" => Ok("macos"),
+            "windows-x86_64" => Ok("win"),
+            wildcard => Err(CliError::UnexpectedError(format!("Self-updating is not supported on your OS ({}) right now, please download the binary manually", wildcard))),
+        };
+
+        let install_dir = match self.install_dir.clone() {
+            Some(dir) => dir,
+            None => {
+                let dir = get_additional_binaries_dir();
+                // Make the directory if it doesn't already exist.
+                std::fs::create_dir_all(&dir)
+                    .with_context(|| format!("Failed to create directory: {:?}", dir))?;
+                dir
+            },
+        };
+
+        BoogieOptions::check_version_is_compatible(
+            BOOGIE_BINARY_NAME,
+            &format!("{}.0", TARGET_BOOGIE_VERSION),
+            MIN_BOOGIE_VERSION,
+            MAX_BOOGIE_VERSION,
+        )?;
+        let res = self
+            .install_binary(
+                install_dir.clone(),
+                BOOGIE_EXE,
+                BOOGIE_BINARY_NAME,
+                TARGET_BOOGIE_VERSION,
+                "/",
+                "Boogie program verifier version ",
+                BOOGIE_EXE_ENV,
+            )
+            .await?;
+        println!("{}", res);
+
+        BoogieOptions::check_version_is_compatible(
+            Z3_BINARY_NAME,
+            TARGET_Z3_VERSION,
+            MIN_Z3_VERSION,
+            MAX_Z3_VERSION,
+        )?;
+        let res = self
+            .install_binary(
+                install_dir.clone(),
+                Z3_EXE,
+                Z3_BINARY_NAME,
+                TARGET_Z3_VERSION,
+                "--",
+                "Z3 version ",
+                Z3_EXE_ENV,
+            )
+            .await?;
+        println!("{}", res);
+
+        #[cfg(unix)]
+        {
+            BoogieOptions::check_version_is_compatible(
+                CVC5_BINARY_NAME,
+                TARGET_CVC5_VERSION,
+                MIN_CVC5_VERSION,
+                MAX_CVC5_VERSION,
+            )?;
+            let res = self
+                .install_binary(
+                    install_dir.clone(),
+                    CVC5_EXE,
+                    CVC5_BINARY_NAME,
+                    TARGET_CVC5_VERSION,
+                    "--",
+                    "This is cvc5 version ",
+                    CVC5_EXE_ENV,
+                )
+                .await?;
+            println!("{}", res);
+        }
+
+        Ok("Succeeded".to_string())
+    }
+
+    async fn install_binary(
+        &self,
+        install_dir: PathBuf,
+        exe_name: &str,
+        binary_name: &str,
+        version: &str,
+        version_option_string: &str,
+        version_match_string: &str,
+        env_name: &str,
+    ) -> CliTypedResult<String> {
+        let installer = DependencyInstaller {
+            binary_name: binary_name.to_string(),
+            exe_name: exe_name.to_string(),
+            env_var: env_name.to_string(),
+            version_option_string: version_option_string.to_string(),
+            version_match_string: version_match_string.to_string(),
+            target_version: version.to_string(),
+            install_dir: Some(install_dir.clone()),
+            check: false,
+        };
+        let result = update_binary(installer).await?;
+
+        let install_dir = install_dir.join(exe_name);
+        if let Err(err) = self.add_env_var(env_name, &install_dir) {
+            eprintln!("{:#}. Please set it manually", err);
+        }
+        Ok(result)
+    }
+}
+
+#[async_trait]
+impl CliCommand<String> for ProverDependencyInstaller {
+    fn command_name(&self) -> &'static str {
+        "InstallProverDependencies"
+    }
+
+    async fn execute(self) -> CliTypedResult<String> {
+        self.download_dependency().await
+    }
+}