add --to-stdout flag to feat/axiom-std-2 (#29)

* WIP: add to_stdout cli param

* stdout for all write fns

* Update  for witnessgen only

* Update readme

sdk/src/run/mod.rs

@@ -48,6 +48,14 @@ pub fn run_cli_on_scaffold<
 >(
     cli: AxiomCircuitRunnerOptions,
 ) {
+    match cli.command {
+        SnarkCmd::WitnessGen => {}
+        _ => {
+            if cli.to_stdout {
+                panic!("The `to_stdout` argument is only valid for the `witness-gen` command.");
+            }
+        }
+    }
     match cli.command {
         SnarkCmd::Mock | SnarkCmd::Prove | SnarkCmd::WitnessGen => {
             if cli.input_path.is_none() {
@@ -236,7 +244,11 @@ pub fn run_cli_on_scaffold<
         }
         SnarkCmd::WitnessGen => {
             let output = witness_gen(&mut runner);
-            write_witness_gen_output(output, cli.data_path.join(PathBuf::from("compute.json")));
+            write_witness_gen_output(
+                output,
+                cli.data_path.join(PathBuf::from("compute.json")),
+                cli.to_stdout,
+            );
         }
     }
 }

sdk/src/run/readme.md

@@ -18,9 +18,10 @@ Options:
   -n, --name <NAME>              Name of the output metadata file [default: circuit]
   -d, --data-path <DATA_PATH>    For saving build artifacts [default: data]
   -c, --config <CONFIG>          For specifying custom circuit parameters
-      --srs <SRS>                For specifying custom KZG params directory [default: params]
-      --aggregate                Whether to aggregate the output (defaults to false)
-      --auto-config-aggregation  Whether to aggregate the output (defaults to false)
+      --srs <SRS>                For specifying custom KZG params directory
+      --aggregate                Whether to aggregate the output [default: false]
+      --auto-config-aggregation  Whether to aggregate the output [default: false]
+  -s, --to-stdout                (witness-gen only) Output to stdout (true) or json (false) [default: false]
   -h, --help                     Print help
   -V, --version                  Print version
 ```

sdk/src/run/types.rs

@@ -91,17 +91,26 @@ pub struct AxiomCircuitRunnerOptions {
 
     #[arg(
         long = "aggregate",
-        help = "Whether to aggregate the output (defaults to false)",
+        help = "Whether to aggregate the output [default: false]",
         action
     )]
     /// Whether to aggregate the output
     pub should_aggregate: bool,
 
     #[arg(
         long = "auto-config-aggregation",
-        help = "Whether to aggregate the output (defaults to false)",
+        help = "Whether to aggregate the output [default: false]",
         action
     )]
     /// Whether to auto calculate the aggregation params
     pub should_auto_config_aggregation_circuit: bool,
+
+    #[arg(
+        short = 's',
+        long = "to-stdout",
+        help = "(witness-gen only) Output to stdout (true) or json (false) [default: false]",
+        action
+    )]
+    /// Whether to output to stdout (true) or json file (false)
+    pub to_stdout: bool,
 }

sdk/src/utils/io.rs

@@ -203,15 +203,21 @@ pub fn write_output(
     info!("Writing JSON output to {:?}", &json_output_path);
     let f = File::create(&json_output_path)
         .unwrap_or_else(|_| panic!("Could not create file at {json_output_path:?}"));
-    serde_json::to_writer_pretty(&f, &output).expect("Writing output should not fail");
+
+        serde_json::to_writer_pretty(&f, &output).expect("Writing output should not fail");
 }
 
 pub fn write_witness_gen_output(
     output: AxiomV2DataAndResults,
     json_output_path: PathBuf,
+    to_stdout: bool,
 ) {
-    info!("Writing JSON output to {:?}", &json_output_path);
-    let f = File::create(&json_output_path)
+    if to_stdout {
+        serde_json::to_writer_pretty(&std::io::stdout(), &output.compute_results).expect("Writing output should not fail");
+    } else {
+        info!("Writing JSON output to {:?}", &json_output_path);
+        let f = File::create(&json_output_path)
         .unwrap_or_else(|_| panic!("Could not create file at {json_output_path:?}"));
-    serde_json::to_writer_pretty(&f, &output.compute_results).expect("Writing output should not fail");
+        serde_json::to_writer_pretty(&f, &output.compute_results).expect("Writing output should not fail");
+    }
 }