Skip to content

Commit f6dad57

Browse files
authored
feat: add --evm flag for cargo openvm setup and bump versions (#1987)
Closes INT-4569
1 parent b6bbef4 commit f6dad57

File tree

8 files changed

+12
-12
lines changed

8 files changed

+12
-12
lines changed

docs/vocs/docs/pages/book/advanced-usage/sdk.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,12 +89,12 @@ After generating a proof, you can verify it. To do so, you need your verifying k
8989
To generate an EVM proof, you'll first need to ensure that you have followed the [CLI installation steps](/book/getting-started/install). get the appropriate KZG params by running the following command.
9090

9191
```bash
92-
cargo openvm setup
92+
cargo openvm setup --evm
9393
```
9494

9595
> ⚠️ **WARNING**
9696
>
97-
> `cargo openvm setup` requires very large amounts of computation and memory (~200 GB).
97+
> `cargo openvm setup --evm` requires very large amounts of computation and memory (~200 GB).
9898
9999
<details>
100100
<summary>Also note that there are additional dependencies for the EVM Proof flow. Click here to view.</summary>
@@ -118,4 +118,4 @@ You can now run the aggregation keygen, proof, and verification functions for th
118118
> ⚠️ **WARNING**
119119
> The aggregation proving key `agg_pk` above is large. Avoid cloning it if possible.
120120
121-
Note that `DEFAULT_PARAMS_DIR` is the directory where Halo2 parameters are stored by the `cargo openvm setup` CLI command. For more information on the setup process, see the `EVM Level` section of the [verify](/book/writing-apps/verifying-proofs) doc.
121+
Note that `DEFAULT_PARAMS_DIR` is the directory where Halo2 parameters are stored by the `cargo openvm setup --evm` CLI command. For more information on the setup process, see the `EVM Level` section of the [verify](/book/writing-apps/verifying-proofs) doc.

docs/vocs/docs/pages/book/getting-started/install.mdx

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 +1.85 install --locked --git http://github.com/openvm-org/openvm.git --tag v1.3.0 cargo-openvm
12+
cargo +1.86 install --locked --git http://github.com/openvm-org/openvm.git --tag v1.4.0-rc.4 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.3.0 --single-branch https://github.com/openvm-org/openvm.git
26+
git clone --branch v1.4.0-rc.4 --single-branch https://github.com/openvm-org/openvm.git
2727
cd openvm
2828
cargo install --locked --force --path crates/cli
2929
```

docs/vocs/docs/pages/book/getting-started/quickstart.mdx

Lines changed: 1 addition & 1 deletion
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.3.0", features = ["std"] }
17+
openvm = { git = "https://github.com/openvm-org/openvm.git", tag = "v1.4.0-rc.4", features = ["std"] }
1818
```
1919

2020
Note that `std` is not enabled by default, so explicitly enabling it is required.

docs/vocs/docs/pages/book/writing-apps/generating-proofs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ If `--proof` is not provided then the command will write the proof to `./${bin_n
4545
The `app` subcommand generates an application-level proof, the `stark` command generates an aggregated root-level proof, while the `evm` command generates an end-to-end EVM proof. For more information on aggregation, see [this specification](https://github.com/openvm-org/openvm/blob/bf8df90b13f4e80bb76dbb71f255a12154c84838/docs/specs/continuations.md).
4646

4747
> ⚠️ **WARNING**
48-
> In order to run the `evm` subcommand, you must have previously called the costly `cargo openvm setup`, which requires very large amounts of computation and memory (~200 GB).
48+
> In order to run the `evm` subcommand, you must have previously called the costly `cargo openvm setup --evm`, which requires very large amounts of computation and memory (~200 GB).
4949
5050
See [EVM Proof Format](./verifying-proofs#evm-proof-json-format) for details on the output format for `cargo openvm prove evm`.
5151

docs/vocs/docs/pages/book/writing-apps/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ The process above details the workflow necessary to build, prove, and verify a g
6969
To do (a), you need to run the following command. If you've run it previously on your machine, there is no need to do so again. This will write files necessary for EVM proving in `~/.openvm/`.
7070

7171
```bash
72-
cargo openvm setup
72+
cargo openvm setup --evm
7373
```
7474

7575
> ⚠️ **WARNING**

docs/vocs/docs/pages/book/writing-apps/solidity-sdk.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Solidity SDK
22

3-
As a supplement to OpenVM, we provide a [Solidity SDK](https://github.com/openvm-org/openvm-solidity-sdk) containing OpenVM verifier contracts generated at official release commits using the `cargo openvm setup` [command](/book/advanced-usage/sdk#setup). The contracts are built at every _minor_ release as OpenVM guarantees verifier backward compatibility across patch releases.
3+
As a supplement to OpenVM, we provide a [Solidity SDK](https://github.com/openvm-org/openvm-solidity-sdk) containing OpenVM verifier contracts generated at official release commits using the `cargo openvm setup --evm` [command](/book/advanced-usage/sdk#setup). The contracts are built at every _minor_ release as OpenVM guarantees verifier backward compatibility across patch releases.
44

55
Note that these builds are for the default aggregation VM config which should be sufficient for most users. If you use a custom config, you will need to manually generate the verifier contract using the [OpenVM SDK](/book/advanced-usage/sdk).
66

docs/vocs/docs/pages/book/writing-apps/verifying-proofs.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ svm use 0.8.19
3838
The workflow for generating an end-to-end EVM proof requires first generating an aggregation proving key and EVM verifier contract. This can be done by running the following command:
3939

4040
```bash
41-
cargo openvm setup
41+
cargo openvm setup --evm
4242
```
4343

44-
Note that `cargo openvm setup` may attempt to download other files (i.e. KZG parameters) from an AWS S3 bucket into `~/.openvm/`.
44+
Note that `cargo openvm setup --evm` may attempt to download other files (i.e. KZG parameters) from an AWS S3 bucket into `~/.openvm/`.
4545

4646
This command can take ~20mins on a `m6a.16xlarge` instance due to the keygen time.
4747

docs/vocs/docs/pages/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import { HomePage } from "vocs/components";
1818

1919
```bash [Build with OpenVM]
2020
# install `cargo openvm`
21-
cargo +1.86 install --locked --git http://github.com/openvm-org/openvm.git --tag v1.4.0 cargo-openvm
21+
cargo +1.86 install --locked --git http://github.com/openvm-org/openvm.git --tag v1.4.0-rc.4 cargo-openvm
2222

2323
# create a starter OpenVM project
2424
cargo openvm init fibonacci

0 commit comments

Comments
 (0)