Skip to content

Commit

Permalink
Merge pull request #806 from 0xPolygonMiden/bobbin-v0.5-cleanup
Browse files Browse the repository at this point in the history
Minor cleanup before v0.5.0 release
  • Loading branch information
bobbinth authored Mar 29, 2023
2 parents 732d454 + ed73c5d commit b7fabf9
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 16 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

## 0.5.0 (TBD)
## 0.5.0 (2023-03-29)

#### CLI
- Renamed `ProgramInfo` to `ExecutionDetails` since there is another `ProgramInfo` struct in the source code.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Miden VM is a zero-knowledge virtual machine written in Rust. For any program ex
* If you'd like to learn more about STARKs, check out the [references](#references) section.

### Status and features
Miden VM is currently on release v0.4. In this release, most of the core features of the VM have been stabilized, and most of the STARK proof generation has been implemented. While we expect to keep making changes to the VM internals, the external interfaces should remain relatively stable, and we will do our best to minimize the amount of breaking changes going forward.
Miden VM is currently on release v0.5. In this release, most of the core features of the VM have been stabilized, and most of the STARK proof generation has been implemented. While we expect to keep making changes to the VM internals, the external interfaces should remain relatively stable, and we will do our best to minimize the amount of breaking changes going forward.

The next version of the VM is being developed in the [next](https://github.com/0xPolygonMiden/miden-vm/tree/next) branch. There is also a documentation for the latest features and changes in the next branch [documentation next branch](https://0xpolygonmiden.github.io/miden-vm/intro/main.html).

Expand Down
13 changes: 2 additions & 11 deletions core/src/utils/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,12 @@ use core::{
};
use winter_utils::{collections::Vec, string::String};

// FEATURE BASED RE-EXPORT
// ================================================================================================

#[cfg(not(feature = "std"))]
pub use alloc::boxed::Box;

#[cfg(feature = "std")]
pub use std::boxed::Box;

// RE-EXPORTS
// ================================================================================================

pub use winter_utils::{
collections, group_slice_elements, group_vector_elements, string, uninit_vector, ByteReader,
ByteWriter, Deserializable, DeserializationError, Serializable, SliceReader,
collections, group_slice_elements, group_vector_elements, string, uninit_vector, Box,
ByteReader, ByteWriter, Deserializable, DeserializationError, Serializable, SliceReader,
};

pub mod math {
Expand Down
2 changes: 1 addition & 1 deletion docs/src/intro/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
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.

## Status and features
Miden VM is currently on release v0.4. In this release, most of the core features of the VM have been stabilized, and most of the STARK proof generation has been implemented. While we expect to keep making changes to the VM internals, the external interfaces should remain relatively stable, and we will do our best to minimize the amount of breaking changes going forward.
Miden VM is currently on release v0.5. In this release, most of the core features of the VM have been stabilized, and most of the STARK proof generation has been implemented. While we expect to keep making changes to the VM internals, the external interfaces should remain relatively stable, and we will do our best to minimize the amount of breaking changes going forward.

At this point, Miden VM is good enough for experimentation, and even for real-world applications, but it is not yet ready for production use. The codebase has not been audited and contains known and unknown bugs and security flaws.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/intro/usage.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Usage
Before you can use Miden VM, you'll need to make sure you have Rust [installed](https://www.rust-lang.org/tools/install). Miden VM v0.4 requires Rust version **1.67** or later.
Before you can use Miden VM, you'll need to make sure you have Rust [installed](https://www.rust-lang.org/tools/install). Miden VM v0.5 requires Rust version **1.67** or later.

Miden VM consists of several crates, each of which exposes a small set of functionality. The most notable of these crates are:
* [miden-processor](https://crates.io/crates/miden-processor), which can be used to execute Miden VM programs.
Expand Down
2 changes: 1 addition & 1 deletion prover/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ where
impl<H, R> Prover for ExecutionProver<H, R>
where
H: ElementHasher<BaseField = Felt>,
R: RandomCoin<BaseField = Felt, Hasher = H> + Sync,
R: RandomCoin<BaseField = Felt, Hasher = H>,
{
type Air = ProcessorAir;
type BaseField = Felt;
Expand Down

0 comments on commit b7fabf9

Please sign in to comment.