Skip to content

Commit

Permalink
chore: Add warning about no_std environment (#1471)
Browse files Browse the repository at this point in the history
* chore: Add warning about `no_std` environment

* specify target triples

* Document all crates with the `no_std` feature
  • Loading branch information
plafer authored Aug 27, 2024
1 parent 07134e3 commit d7c8933
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `wasm32-unknown-unknown` and `wasm32-wasip1` targets are 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.
Expand Down
1 change: 1 addition & 0 deletions miden/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](<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.

Expand Down
1 change: 1 addition & 0 deletions processor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
1 change: 1 addition & 0 deletions prover/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
1 change: 1 addition & 0 deletions verifier/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit d7c8933

Please sign in to comment.