feat(starknet_committer_and_os_cli): add command to dump OS source files

Author: dorimedini-starkware

.github/workflows/committer_and_os_cli_push.yml

@@ -21,6 +21,7 @@ on:
       - 'docker-ci/images/sequencer-ci.Dockerfile'
       - 'Cargo.toml'
       - 'Cargo.lock'
+      - 'crates/apollo_starknet_os_program/**'
       - 'crates/starknet_committer_and_os_cli/**'
       - 'crates/starknet_api/**'
       - 'crates/starknet_committer/**'

Cargo.lock

@@ -18,6 +18,8 @@ tempfile.workspace = true
 
 # TODO(Amos): Add `testing` feature and move Python test dependencies under it.
 [dependencies]
+# The 'dump_source_files' feature should be moved under `testing` feature, when it exists.
+apollo_starknet_os_program = { workspace = true, features = ["dump_source_files"] }
 cairo-lang-starknet-classes.workspace = true
 cairo-vm = { workspace = true, features = [
   "cairo-0-data-availability-hints",
@@ -39,7 +41,7 @@ serde_repr.workspace = true
 starknet-types-core.workspace = true
 starknet_api.workspace = true
 starknet_committer.workspace = true
-# Should be moved under `testing` feature, when it exists.
+# The 'testing' feature should be moved under `testing` feature, when it exists.
 starknet_os = { workspace = true, features = ["deserialize", "testing"] }
 starknet_patricia = { workspace = true, features = ["testing"] }
 starknet_patricia_storage.workspace = true

crates/starknet_committer_and_os_cli/Cargo.toml

@@ -1,6 +1,7 @@
 use std::fs;
 use std::path::Path;
 
+use apollo_starknet_os_program::CAIRO_FILES_MAP;
 use cairo_lang_starknet_classes::casm_contract_class::CasmContractClass;
 use cairo_vm::types::layout_name::LayoutName;
 use cairo_vm::vm::runners::cairo_pie::CairoPie;
@@ -101,3 +102,7 @@ pub(crate) fn serialize_os_runner_output(
         .write_zip_file(Path::new(&cairo_pie_zip_path), merge_extra_segments)
         .unwrap_or_else(|err| panic!("Failed to write cairo pie. Error: {}", err));
 }
+
+pub(crate) fn dump_source_files(output_path: String) {
+    write_to_file(&output_path, &*CAIRO_FILES_MAP);
+}

crates/starknet_committer_and_os_cli/src/os_cli/commands.rs

@@ -9,7 +9,7 @@ use tracing::level_filters::LevelFilter;
 use tracing_subscriber::reload::Handle;
 use tracing_subscriber::Registry;
 
-use crate::os_cli::commands::parse_and_run_os;
+use crate::os_cli::commands::{dump_source_files, parse_and_run_os};
 use crate::os_cli::tests::python_tests::OsPythonTestRunner;
 use crate::shared_utils::types::{run_python_test, IoArgs, PythonTestArg};
 
@@ -21,6 +21,11 @@ pub struct OsCliCommand {
 
 #[derive(Debug, Subcommand)]
 enum Command {
+    DumpSourceFiles {
+        /// File path to output.
+        #[clap(long, short = 'o')]
+        output_path: String,
+    },
     PythonTest(PythonTestArg),
     RunOsStateless {
         #[clap(flatten)]
@@ -34,6 +39,7 @@ pub async fn run_os_cli(
 ) {
     info!("Starting starknet-os-cli with command: \n{:?}", os_command);
     match os_command.command {
+        Command::DumpSourceFiles { output_path } => dump_source_files(output_path),
         Command::PythonTest(python_test_arg) => {
             run_python_test::<OsPythonTestRunner>(python_test_arg).await;
         }