cosmwasm-check 3.0.5

//! CosmWasm is a smart contract platform for the Cosmos ecosystem.
//! This binary provides a CLI tool for verifying CosmWasm smart contracts before uploading to a blockchain.
//!
//! For more information, see: <https://cosmwasm.cosmos.network>

use std::collections::HashSet;
use std::fs::File;
use std::io::Read;
use std::path::Path;
use std::process::exit;
use std::time::Instant;

use anyhow::Context;
use clap::{Arg, ArgAction, Command};
use colored::Colorize;

use cosmwasm_std::{from_json, StdResultExt};
use cosmwasm_vm::internals::{check_wasm, compile, make_compiling_engine, LogOutput, Logger};
use cosmwasm_vm::{capabilities_from_csv, WasmLimits};

const DEFAULT_AVAILABLE_CAPABILITIES: &str =
    "ibc2,iterator,staking,stargate,cosmwasm_1_1,cosmwasm_1_2,cosmwasm_1_3,cosmwasm_1_4,cosmwasm_2_0,cosmwasm_2_1,cosmwasm_2_2";

pub fn main() {
    let matches = Command::new("Contract checking")
        .version(env!("CARGO_PKG_VERSION"))
        .long_about("Checks the given wasm file (memories, exports, imports, available capabilities, and non-determinism).")
        .author("Mauro Lacy <mauro@lacy.com.es>")
        .arg(
            Arg::new("CAPABILITIES")
                // `long` setting required to turn the position argument into an option 🤷
                .long("available-capabilities")
                .aliases(["FEATURES", "supported-features"]) // Old names
                .value_name("CAPABILITIES")
                .help("Sets the available capabilities that the desired target chain has")
                .num_args(1)
                .action(ArgAction::Set),
        )
        .arg(
            Arg::new("VERBOSE")
                .long("verbose")
                .num_args(0)
                .help("Prints additional information on stderr")
                .action(ArgAction::SetTrue),
        )
        .arg(
            Arg::new("LIMITS")
            .long("wasm-limits")
            .help("Provide either a file or string containing the chain's json-encoded wasm limits configuration.")
            .long_help("Provide either a file or string containing the chain's json-encoded wasm limits configuration.
You can query this configuration from the chain, using the 'cosmwasm.wasm.v1.Query/WasmLimitsConfig' query.
If this is not provided, the default values are used.")
            .num_args(1)
            .action(ArgAction::Set)
        )
        .arg(
            Arg::new("WASM")
                .help("Wasm file to read and compile")
                .required(true)
                .index(1)
                .num_args(0..)
                .action(ArgAction::Append),
        )
        .get_matches();

    // Available capabilities
    let available_capabilities_csv = matches
        .get_one::<String>("CAPABILITIES")
        .map(|s| s.as_str())
        .unwrap_or(DEFAULT_AVAILABLE_CAPABILITIES);
    let available_capabilities = capabilities_from_csv(available_capabilities_csv);
    println!("Available capabilities: {available_capabilities:?}");
    println!();

    // Wasm limits
    let wasm_limits = matches
        .get_one::<String>("LIMITS")
        .map(|input| read_wasm_limits(input).unwrap())
        .unwrap_or_default();

    // File
    let paths = matches
        .get_many::<String>("WASM")
        .expect("Error parsing file names");

    let (passes, failures): (Vec<_>, _) = paths
        .map(|p| {
            let result = check_contract(
                p,
                &available_capabilities,
                matches.get_flag("VERBOSE"),
                &wasm_limits,
            );
            match &result {
                Ok(_) => println!("{}: {}", p, "pass".green()),
                Err(e) => {
                    println!("{}: {}", p, "failure".red());
                    println!("{e}");
                }
            };
            result
        })
        .partition(|result| result.is_ok());
    println!();

    if failures.is_empty() {
        println!(
            "All contracts ({}) {} checks!",
            passes.len(),
            "passed".green()
        );
    } else {
        println!(
            "{}: {}, {}: {}",
            "Passes".green(),
            passes.len(),
            "failures".red(),
            failures.len()
        );
        exit(1);
    }
}

fn read_wasm_limits(input: &str) -> anyhow::Result<WasmLimits> {
    // try to parse JSON, if that fails, try to open as File and parse that
    from_json::<WasmLimits>(input)
        .unwrap_std_error()
        .map_err(anyhow::Error::from_boxed)
        .context("error parsing wasm limits")
        .or_else(|_| {
            std::fs::read_to_string(input)
                .context("error reading wasm limits file")
                .and_then(|s| {
                    from_json(s)
                        .unwrap_std_error()
                        .map_err(anyhow::Error::from_boxed)
                        .context("error parsing wasm limits file")
                })
        })
}

fn check_contract(
    path: &str,
    available_capabilities: &HashSet<String>,
    verbose: bool,
    wasm_limits: &WasmLimits,
) -> anyhow::Result<()> {
    let mut file = File::open(path)?;

    // Read wasm
    let mut wasm = Vec::<u8>::new();
    file.read_to_end(&mut wasm)?;

    // Potentially lossy filename or path as used as a short prefix for the output
    let filename_identifier: String = Path::new(path)
        .file_name()
        .map(|f| f.to_string_lossy().into_owned())
        .unwrap_or(path.to_string());
    let prefix = format!("    {}: ", filename_identifier);
    let logs = if verbose {
        Logger::On {
            prefix: &prefix,
            output: LogOutput::StdErr,
        }
    } else {
        Logger::Off
    };
    // Check wasm
    check_wasm(&wasm, available_capabilities, wasm_limits, logs)?;

    // Compile module
    let start = Instant::now();
    {
        let engine = make_compiling_engine(None);
        let _module = compile(&engine, &wasm)?;
    }
    if verbose {
        let duration = start.elapsed();
        eprintln!("Compile time: {:?}", duration);
    }

    Ok(())
}