snarkos-cli 4.9.0

// Copyright (c) 2019-2026 Provable Inc.
// This file is part of the snarkOS library.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:

// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use colored::Colorize;
use self_update::{UpdateConfig, VersionStatus, backends::github, version::bump_is_greater};
use std::fmt::Write;

pub struct Updater;

impl Updater {
    const SNARKOS_BIN_NAME: &'static str = "snarkos";
    const SNARKOS_REPO_NAME: &'static str = "snarkOS";
    const SNARKOS_REPO_OWNER: &'static str = "ProvableHQ";

    /// Show all available releases for `snarkos`.
    pub fn show_available_releases() -> Result<String, UpdaterError> {
        let releases = github::ReleaseList::configure()
            .repo_owner(Self::SNARKOS_REPO_OWNER)
            .repo_name(Self::SNARKOS_REPO_NAME)
            .build()?
            .fetch()?;

        let mut output = "List of available versions\n".to_string();
        for release in releases {
            let _ = writeln!(output, "  * {}", release.version());
        }
        Ok(output)
    }

    /// Update `snarkOS` to the specified release.
    pub fn update_to_release(show_output: bool, version: Option<String>) -> Result<VersionStatus, UpdaterError> {
        let mut update_builder = github::Update::configure();

        update_builder
            .repo_owner(Self::SNARKOS_REPO_OWNER)
            .repo_name(Self::SNARKOS_REPO_NAME)
            .bin_name(Self::SNARKOS_BIN_NAME)
            .current_version(env!("SNARKOS_VERSION"))
            .show_download_progress(show_output)
            .no_confirm(true)
            .show_output(show_output);

        let status = match version {
            None => update_builder.build()?.update()?,
            Some(v) => update_builder.release_tag(&v).build()?.update()?,
        };

        Ok(status)
    }

    /// Check if there is an available update for `snarkos` and return the newest release.
    pub fn update_available() -> Result<String, UpdaterError> {
        let updater = github::Update::configure()
            .repo_owner(Self::SNARKOS_REPO_OWNER)
            .repo_name(Self::SNARKOS_REPO_NAME)
            .bin_name(Self::SNARKOS_BIN_NAME)
            .current_version(env!("SNARKOS_VERSION"))
            .build()?;

        let current_version = updater.current_version().to_string();
        let latest_releases = updater.get_latest_release()?;
        let latest_release = latest_releases
            .latest()
            .ok_or_else(|| UpdaterError::Crate("self_update", "no releases found".to_string()))?;

        if bump_is_greater(&current_version, latest_release.version())? {
            Ok(latest_release.version().to_string())
        } else {
            Err(UpdaterError::OldReleaseVersion(current_version, latest_release.version().to_string()))
        }
    }

    /// Returns the message to be printed to the CLI (if any).
    pub fn print_cli() -> Option<String> {
        if let Ok(latest_version) = Self::update_available() {
            let mut output = "🟢 A new version is available! Run".bold().green().to_string();
            output += &" `snarkos update` ".bold().white();
            output += &format!("to update to v{latest_version}.").bold().green();
            Some(output)
        } else {
            None
        }
    }
}

#[cfg(test)]
mod tests {
    use std::{fs, path::Path};

    #[test]
    fn snarkos_version_matches_release_version() {
        let release_version = Path::new(env!("CARGO_MANIFEST_DIR"))
            .ancestors()
            .map(|dir| dir.join(".cargo").join("release-version"))
            .find(|path| path.is_file())
            .map(|path| fs::read_to_string(path).unwrap())
            .unwrap();

        assert_eq!(env!("SNARKOS_VERSION"), release_version.trim().trim_start_matches('v'));
    }
}

#[derive(Debug, Error)]
pub enum UpdaterError {
    #[error("{}: {}", _0, _1)]
    Crate(&'static str, String),

    #[error("The current version {} is more recent than the release version {}", _0, _1)]
    OldReleaseVersion(String, String),
}

impl From<self_update::errors::Error> for UpdaterError {
    fn from(error: self_update::errors::Error) -> Self {
        UpdaterError::Crate("self_update", error.to_string())
    }
}