provekit_nargo_cli 1.0.0-beta.20-alpha.1

Noir's package manager
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

use std::path::PathBuf;

use clap::Args;

use nargo::constants::PROVER_INPUT_FILE;
use nargo::workspace::Workspace;
use nargo_toml::PackageSelection;
use noirc_driver::CompileOptions;

use super::compile_cmd::compile_workspace_full;
use super::{LockType, PackageOptions, WorkspaceCommand};
use crate::cli::execute_cmd::interpret::run_comptime;
use crate::errors::CliError;

mod interpret;

/// Executes a circuit to calculate its return value
#[derive(Debug, Clone, Args)]
#[clap(visible_alias = "e")]
pub(crate) struct ExecuteCommand {
    /// Write the execution witness to named file
    ///
    /// Defaults to the name of the package being executed.
    witness_name: Option<String>,

    /// The name of the toml file which contains the inputs for the prover
    #[clap(long, short, default_value = PROVER_INPUT_FILE)]
    prover_name: String,

    /// Optionally overwrite the `return` entry in the prover file.
    #[clap(long, default_value_t = false)]
    pub overwrite_return: bool,

    #[clap(flatten)]
    pub(super) package_options: PackageOptions,

    #[clap(flatten)]
    compile_options: CompileOptions,

    /// JSON RPC url to solve oracle calls
    #[clap(long, conflicts_with = "oracle_file")]
    oracle_resolver: Option<String>,

    /// Path to the oracle transcript.
    #[clap(long, conflicts_with = "oracle_resolver")]
    oracle_file: Option<PathBuf>,

    /// Force comptime execution
    #[arg(long, hide = true)]
    force_comptime: bool,
}

impl WorkspaceCommand for ExecuteCommand {
    fn package_selection(&self) -> PackageSelection {
        self.package_options.package_selection()
    }

    fn lock_type(&self) -> LockType {
        // Compiles artifacts.
        LockType::Exclusive
    }
}

pub(crate) fn run(args: ExecuteCommand, workspace: Workspace) -> Result<(), CliError> {
    if args.force_comptime {
        return run_comptime(args, workspace);
    }

    // Compile the full workspace in order to generate any build artifacts.
    let debug_compile_stdin = None;
    compile_workspace_full(&workspace, &args.compile_options, debug_compile_stdin)?;

    let binary_packages = workspace.into_iter().filter(|package| package.is_binary());
    for package in binary_packages {
        let program_artifact_path = workspace.package_build_path(package);
        let prover_file = package.root_dir.join(&args.prover_name).with_extension("toml");

        let cmd = noir_artifact_cli::commands::execute_cmd::ExecuteCommand {
            artifact_path: program_artifact_path,
            prover_file,
            overwrite_return: args.overwrite_return,
            output_dir: Some(workspace.target_directory_path()),
            witness_name: Some(
                args.witness_name.clone().unwrap_or_else(|| package.name.to_string()),
            ),
            contract_fn: None,
            oracle_file: args.oracle_file.clone(),
            oracle_resolver: args.oracle_resolver.clone(),
            oracle_root_dir: Some(workspace.root_dir.clone()),
            oracle_package_name: Some(package.name.to_string()),
        };

        noir_artifact_cli::commands::execute_cmd::run(cmd)?;
    }
    Ok(())
}