leo-lang 4.4.0

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

// The Leo library 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.

// The Leo library 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 the Leo library. If not, see <https://www.gnu.org/licenses/>.

use snarkvm::prelude::{ConsensusVersion, Network, Program};

/// Threshold percentage for program size warnings.
const PROGRAM_SIZE_WARNING_THRESHOLD: usize = 90;

/// Formats program size as KB and returns a warning message if approaching the limit.
///
/// Both `size` and `max_size` are expected in bytes.
/// Returns `(size_kb, max_kb, warning)` where `warning` is `Some` if size exceeds 90% of max.
pub fn format_program_size(size: usize, max_size: usize) -> (f64, f64, Option<String>) {
    let size_kb = size as f64 / 1024.0;
    let max_kb = max_size as f64 / 1024.0;
    let percentage = (size as f64 / max_size as f64) * 100.0;

    let warning = if size > max_size * PROGRAM_SIZE_WARNING_THRESHOLD / 100 {
        Some(format!("approaching the size limit ({percentage:.1}% of {max_kb:.2} KB)"))
    } else {
        None
    };

    (size_kb, max_kb, warning)
}

/// Default edition for local programs during local operations (run, execute, synthesize).
///
/// Local programs don't have an on-chain edition yet. We default to edition 1 to avoid
/// snarkVM's V8+ check that rejects edition 0 programs without constructors. That check
/// is only relevant for deployed programs, not local development.
pub const LOCAL_PROGRAM_DEFAULT_EDITION: leo_package::Edition = 1;

/// Prints a program's ID and source (local or network edition).
pub fn print_program_source(id: &str, edition: Option<leo_package::Edition>) {
    match (id, edition) {
        ("credits.aleo", _) => println!("  - {id} (already included)"),
        (_, Some(e)) => println!("  - {id} (edition: {e})"),
        (_, None) => println!("  - {id} (local)"),
    }
}

/// Checks if any programs violate edition/constructor requirements.
///
/// Programs at edition 0 without a constructor cannot be executed after ConsensusVersion::V8.
/// This check should be performed before attempting execution to provide a clear error message.
///
/// # Arguments
/// * `programs` - Slice of (program, edition) tuples to check
/// * `consensus_version` - The current consensus version
/// * `action` - Description of the action being attempted (e.g., "deploy", "execute", "upgrade")
///
/// # Returns
/// `Ok(())` if all programs pass the check, or an error with a descriptive message if not.
pub fn check_edition_constructor_requirements<N: Network>(
    programs: &[(Program<N>, leo_package::Edition)],
    consensus_version: ConsensusVersion,
    action: &str,
) -> Result<(), leo_errors::Backtraced> {
    // Only check for V8+ consensus versions.
    if consensus_version < ConsensusVersion::V8 {
        return Ok(());
    }

    for (program, edition) in programs {
        // Programs at edition 0 without a constructor cannot be executed after V8.
        if *edition == 0 && !program.contains_constructor() {
            let id = program.id();
            // Skip credits.aleo as it's a special case.
            if id.to_string() != "credits.aleo" {
                return Err(crate::errors::custom(format!(
                    "Cannot {action} with dependency '{id}' (edition 0)\n\n\
                    Programs at edition 0 without a constructor cannot be executed under \
                    consensus version V8 or later (current: V{}).\n\n\
                    The program '{id}' must be upgraded on-chain before it can be used.",
                    consensus_version as u8
                )));
            }
        }
    }

    Ok(())
}

/// Load additional programs specified by `--with` and add them to the VM.
///
/// Each entry is either a local `.aleo` file path (if it exists on disk)
/// or a remote program name fetched from the network endpoint with transitive dependencies.
pub fn load_extra_programs_into_vm<N: Network>(
    entries: &[String],
    vm: &snarkvm::prelude::VM<N, snarkvm::prelude::store::helpers::memory::ConsensusMemory<N>>,
    context: &crate::cli::context::Context,
    network: leo_ast::NetworkName,
    endpoint: Option<&str>,
    network_retries: u32,
) -> leo_errors::Result<()> {
    use snarkvm::prelude::ProgramID;
    use std::{path::Path, str::FromStr};

    let mut extras: Vec<(Program<N>, leo_package::Edition)> = Vec::new();

    for entry in entries {
        let path = Path::new(entry);
        if path.is_file() {
            println!("📂 Loading local program from {entry}...");
            let bytecode = std::fs::read_to_string(path)
                .map_err(|e| crate::errors::custom(format!("Failed to read program file '{entry}': {e}")))?;
            let program = Program::<N>::from_str(&bytecode)
                .map_err(|e| crate::errors::custom(format!("Failed to parse program from '{entry}': {e}")))?;
            extras.push((program, LOCAL_PROGRAM_DEFAULT_EDITION));
        } else if path.exists() {
            return Err(crate::errors::custom(format!("'{entry}' exists but is not a file.")).into());
        } else {
            let endpoint = endpoint.ok_or_else(|| {
                crate::errors::custom(format!(
                    "'{entry}' is not a local file; fetching from the network requires --endpoint to be set."
                ))
            })?;
            let name = if entry.ends_with(".aleo") { entry.clone() } else { format!("{entry}.aleo") };
            println!("⬇️  Fetching remote program {name} and its dependencies from {endpoint}...");
            let program_id = ProgramID::<N>::from_str(&name)
                .map_err(|e| crate::errors::custom(format!("Failed to parse program ID '{name}': {e}")))?;
            let fetched = super::query::load_latest_programs_from_network(
                context,
                program_id,
                network,
                endpoint,
                network_retries,
            )?;
            extras.extend(fetched.into_iter().map(|(p, ed)| (p, ed.unwrap_or(LOCAL_PROGRAM_DEFAULT_EDITION))));
        }
    }

    vm.process().lock().add_programs_with_editions(&extras)?;

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use snarkvm::prelude::TestnetV0;
    use std::str::FromStr;

    #[test]
    fn test_edition_constructor_error_message() {
        // A program without a constructor at edition 0 should fail under V8+
        let program = Program::<TestnetV0>::from_str(
            "program old_program.aleo;\nfunction main:\n    input r0 as u32.public;\n    output r0 as u32.public;\n",
        )
        .unwrap();

        let result = check_edition_constructor_requirements(&[(program, 0)], ConsensusVersion::V9, "deploy");
        assert!(result.is_err());
    }
}