Merge branch 'main' into add-zero-segment

CHANGELOG.md

@@ -4,6 +4,14 @@
 
 * feat: Add zero segment [#1668](https://github.com/lambdaclass/cairo-vm/pull/1668)
 
+* feat(BREAKING): Use return type info from sierra when serializing return values in cairo1-run crate [#1665](https://github.com/lambdaclass/cairo-vm/pull/1665)
+  * Removed public function `serialize_output`.
+  * Add field `serialize_output` to `Cairo1RunConfig`.
+  * Function `cairo_run_program` now returns an extra `Option<String>` value with the serialized output if `serialize_output` is enabled in the config.
+  * Output serialization improved as it now uses the sierra program data to identify return value's types.
+
+* feat: Create hyper_threading crate to benchmark the `cairo-vm` in a hyper-threaded environment [#1679](https://github.com/lambdaclass/cairo-vm/pull/1679)
+
 * feat: add a `--tracer` option which hosts a web server that shows the line by line execution of cairo code along with memory registers [#1265](https://github.com/lambdaclass/cairo-vm/pull/1265)
 
 * feat: Fix error handling in `initialize_state`[#1657](https://github.com/lambdaclass/cairo-vm/pull/1657)

CODEOWNERS

@@ -1 +1 @@
-* @igaray @Oppen @fmoletta @entropidelic @juanbono @pefontana
+* @igaray @Oppen @fmoletta @juanbono @pefontana

Cargo.toml

@@ -5,7 +5,8 @@ members = [
     "hint_accountant",
     "examples/wasm-demo",
     "cairo1-run",
-    "cairo-vm-tracer"
+    "cairo-vm-tracer",
+    "examples/hyper_threading"
 ]
 default-members = [
     "cairo-vm-cli",

Makefile

@@ -17,6 +17,7 @@ endif
 	compare_benchmarks_deps compare_benchmarks docs clean \
 	compare_trace_memory compare_trace compare_memory compare_pie compare_all_no_proof \
 	compare_trace_memory_proof  compare_all_proof compare_trace_proof compare_memory_proof compare_air_public_input  compare_air_private_input\
+	hyper-threading-benchmarks \
 	cairo_bench_programs cairo_proof_programs cairo_test_programs cairo_1_test_contracts cairo_2_test_contracts \
 	cairo_trace cairo-vm_trace cairo_proof_trace cairo-vm_proof_trace \
 	fuzzer-deps fuzzer-run-cairo-compiled fuzzer-run-hint-diff build-cairo-lang hint-accountant \ create-proof-programs-symlinks \
@@ -375,3 +376,7 @@ hint-accountant: build-cairo-lang
 
 create-proof-programs-symlinks:
 	cd cairo_programs/proof_programs; ln -s ../*.cairo .
+
+hyper-threading-benchmarks: cairo_bench_programs
+	cargo build -p hyper_threading --release && \
+	sh examples/hyper_threading/hyper-threading.sh

README.md

@@ -22,7 +22,6 @@ A faster and safer implementation of the Cairo VM in Rust
 ## Table of Contents
 
 - [Table of Contents](#table-of-contents)
-- [⚠️ Disclaimer](#️-disclaimer)
 - [📖 About](#-about)
   - [The Cairo language](#the-cairo-language)
 - [🌅 Getting Started](#-getting-started)
@@ -53,10 +52,6 @@ A faster and safer implementation of the Cairo VM in Rust
     - [STARKs](#starks)
 - [⚖️ License](#️-license)
 
-## ⚠️ Disclaimer
-
-🚧 `cairo-vm` is still being built therefore breaking changes might happen often so use it at your own risk. 🚧
-Cargo doesn't comply with [semver](https://semver.org/), so we advise to pin the version to 0.1.0. This can be done adding `cairo-vm = "0.1.0"` to your Cargo.toml
 
 ## 📖 About
 
@@ -300,6 +295,12 @@ Run only the `iai_benchmark` benchmark suite with cargo:
 cargo bench --bench iai_benchmark
 ```
 
+Benchmark the `cairo-vm` in a hyper-threaded environment with the [`examples/hyper_threading/ crate`](examples/hyper_threading/)
+```bash
+make hyper-threading-benchmarks
+```
+
+
 ## 📜 Changelog
 
 Keeps track of the latest changes [here](CHANGELOG.md).

cairo1-run/Cargo.toml

@@ -26,6 +26,7 @@ bincode.workspace = true
 assert_matches = "1.5.0"
 rstest = "0.17.0"
 mimalloc = { version = "0.1.37", default-features = false, optional = true }
+num-traits = { version = "0.2", default-features = false }
 
 [features]
 default = ["with_mimalloc"]