Skip to content

Commit 5368d47

Browse files
chore: update book for v1.3.0 release (#1865)
close INT-4395
1 parent 62fe88a commit 5368d47

File tree

4 files changed

+9
-10
lines changed

4 files changed

+9
-10
lines changed

.github/workflows/versioning.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ on:
55
workflow_dispatch:
66
inputs:
77
version:
8-
description: "Version tag to compare (e.g., v1.2.0)"
8+
description: "Version tag to compare (e.g., v1.3.0)"
99
required: true
10-
default: "v1.2.0"
10+
default: "v1.3.0"
1111
type: string
1212

1313
jobs:
@@ -22,7 +22,7 @@ jobs:
2222
uses: actions/checkout@v4
2323

2424
- name: Set version fallback
25-
run: echo "version=${{ github.event.inputs.version || 'v1.2.0' }}" >> $GITHUB_ENV
25+
run: echo "version=${{ github.event.inputs.version || 'v1.3.0' }}" >> $GITHUB_ENV
2626

2727
- name: Install solc # svm should support arm64 linux
2828
run: (hash svm 2>/dev/null || cargo install --version 0.2.23 svm-rs) && svm install 0.8.19 && solc --version

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ All notable changes to OpenVM will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project follows a versioning principles documented in [VERSIONING.md](./VERSIONING.md).
77

8-
## v1.3.0 (2025-07-14)
8+
## v1.3.0 (2025-07-15)
99

1010
No circuit constraints or verifying keys were changed in this release.
1111

@@ -29,6 +29,7 @@ Users are advised to switch to using the new guest libraries.
2929
- (SDK) New functions `generate_e2e_stark_proof` and `verify_e2e_stark_proof`
3030

3131
### Changed
32+
- (Toolchain) The `openvm` crate and `cargo openvm build` command have been updated to support both `getrandom` `v0.2` and `v0.3`.
3233
- (Primitives Libraries) In the algebra and elliptic curve primitive libraries, the `setup_*` functions have been removed from guest bindings and are now called on-demand within other relevant binding functions. Additionally, custom opcode initialization is now simplified through the inclusion of `openvm_init.rs` files and the `openvm::init!()` macro. Read the book for more details.
3334
- (CLI) The build command `cargo openvm build` now stores build artifacts in the `target/` to match cargo conventions.
3435
- (CLI) The `cargo openvm setup` command now supports skipping halo2 proving keys and outputs halo2 PK and STARK PK as separate files.

book/src/getting-started/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ To use OpenVM for generating proofs, you must install the OpenVM command line to
99
Begin the installation:
1010

1111
```bash
12-
cargo install --locked --git http://github.com/openvm-org/openvm.git --tag v1.2.0 cargo-openvm
12+
cargo +1.85 install --locked --git http://github.com/openvm-org/openvm.git --tag v1.3.0 cargo-openvm
1313
```
1414

1515
This will globally install `cargo-openvm`. You can validate a successful installation with:
@@ -23,7 +23,7 @@ cargo openvm --version
2323
To build from source, clone the repository and begin the installation.
2424

2525
```bash
26-
git clone --branch v1.2.0 --single-branch https://github.com/openvm-org/openvm.git
26+
git clone --branch v1.3.0 --single-branch https://github.com/openvm-org/openvm.git
2727
cd openvm
2828
cargo install --locked --force --path crates/cli
2929
```

book/src/getting-started/quickstart.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This will generate an OpenVM-specific starter package. Notice `Cargo.toml` has t
1414

1515
```toml
1616
[dependencies]
17-
openvm = { git = "https://github.com/openvm-org/openvm.git", tag = "v1.2.0", features = ["std"] }
17+
openvm = { git = "https://github.com/openvm-org/openvm.git", tag = "v1.3.0", features = ["std"] }
1818
```
1919

2020
Note that `std` is not enabled by default, so explicitly enabling it is required.
@@ -66,16 +66,14 @@ This will output a serialized proving key to `./target/openvm/app.pk` and a veri
6666
Now we are ready to generate a proof! Simply run:
6767

6868
```bash
69-
OPENVM_FAST_TEST=1 cargo openvm prove app --input "0x010A00000000000000"
69+
cargo openvm prove app --input "0x010A00000000000000"
7070
```
7171

7272
The `--input` field is passed to the program which receives it via the `io::read` function.
7373
In our `main.rs` we called `read()` to get `n: u64`. The input here is `n = 10u64` _in little endian_. Note that this value must be padded to exactly 8 bytes (64 bits) and is prefixed with `0x01` to indicate that the input is composed of raw bytes.
7474

7575
The serialized proof will be output to `./fibonacci.app.proof`.
7676

77-
The `OPENVM_FAST_TEST` environment variable is used to enable fast proving for testing purposes. To run with proof with secure parameters, remove the environmental variable.
78-
7977
## Proof Verification
8078

8179
Finally, the proof can be verified.

0 commit comments

Comments
 (0)