From f30002bb55cd41f249da8cf25769566685299ab0 Mon Sep 17 00:00:00 2001 From: Philippe Laferriere Date: Tue, 27 Aug 2024 13:47:24 -0400 Subject: [PATCH 1/3] chore: Add warning about `no_std` environment --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 42a6dbbcd..cd853abc7 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ A STARK-based virtual machine. **WARNING:** This project is in an alpha stage. It has not been audited and may contain bugs and security flaws. This implementation is NOT ready for production use. +**WARNING:** For `no_std`, only the WASM environment is officially supported. + ## Overview Miden VM is a zero-knowledge virtual machine written in Rust. For any program executed on Miden VM, a STARK-based proof of execution is automatically generated. This proof can then be used by anyone to verify that the program was executed correctly without the need for re-executing the program or even knowing the contents of the program. From 88704f876c0af475ecd602fb9c18543c51fb5e93 Mon Sep 17 00:00:00 2001 From: Philippe Laferriere Date: Tue, 27 Aug 2024 13:58:04 -0400 Subject: [PATCH 2/3] specify target triples --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cd853abc7..3a45e1775 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ A STARK-based virtual machine. **WARNING:** This project is in an alpha stage. It has not been audited and may contain bugs and security flaws. This implementation is NOT ready for production use. -**WARNING:** For `no_std`, only the WASM environment is officially supported. +**WARNING:** For `no_std`, only the `wasm32-unknown-unknown` and `wasm32-wasip1` targets are officially supported. ## Overview From 2ed46fca668f0c08bf71f4b43ab488ace51a4efb Mon Sep 17 00:00:00 2001 From: Philippe Laferriere Date: Tue, 27 Aug 2024 14:02:31 -0400 Subject: [PATCH 3/3] Document all crates with the `no_std` feature --- miden/README.md | 1 + processor/README.md | 1 + prover/README.md | 1 + verifier/README.md | 1 + 4 files changed, 4 insertions(+) diff --git a/miden/README.md b/miden/README.md index 951991a06..4ba24e7d5 100644 --- a/miden/README.md +++ b/miden/README.md @@ -308,6 +308,7 @@ Miden VM can be compiled with the following features: - `executable` - required for building Miden VM binary as described above. Implies `std`. - `metal` - enables [Metal]()-based acceleration of proof generation (for recursive proofs) on supported platforms (e.g., Apple silicon). - `no_std` does not rely on the Rust standard library and enables compilation to WebAssembly. + - Only the `wasm32-unknown-unknown` and `wasm32-wasip1` targets are officially supported. To compile with `no_std`, disable default features via `--no-default-features` flag. diff --git a/processor/README.md b/processor/README.md index b0d993561..837bb5fde 100644 --- a/processor/README.md +++ b/processor/README.md @@ -63,6 +63,7 @@ Miden processor can be compiled with the following features: * `std` - enabled by default and relies on the Rust standard library. * `no_std` does not rely on the Rust standard library and enables compilation to WebAssembly. + * Only the `wasm32-unknown-unknown` and `wasm32-wasip1` targets are officially supported. To compile with `no_std`, disable default features via `--no-default-features` flag. diff --git a/prover/README.md b/prover/README.md index 9f07ee2f0..be22bbe55 100644 --- a/prover/README.md +++ b/prover/README.md @@ -46,6 +46,7 @@ Miden prover can be compiled with the following features: * `concurrent` - implies `std` and also enables multi-threaded proof generation. * `metal` - enables [Metal](https://en.wikipedia.org/wiki/Metal_(API))-based acceleration of proof generation (for recursive proofs) on supported platforms (e.g., Apple silicon). * `no_std` does not rely on the Rust standard library and enables compilation to WebAssembly. + * Only the `wasm32-unknown-unknown` and `wasm32-wasip1` targets are officially supported. To compile with `no_std`, disable default features via `--no-default-features` flag. diff --git a/verifier/README.md b/verifier/README.md index 691b9144c..5f896e022 100644 --- a/verifier/README.md +++ b/verifier/README.md @@ -28,6 +28,7 @@ Miden verifier can be compiled with the following features: * `std` - enabled by default and relies on the Rust standard library. * `no_std` does not rely on the Rust standard library and enables compilation to WebAssembly. + * Only the `wasm32-unknown-unknown` and `wasm32-wasip1` targets are officially supported. To compile with `no_std`, disable default features via `--no-default-features` flag.