Skip to content

Commit

Permalink
docs: version nits (#1774)
Browse files Browse the repository at this point in the history
  • Loading branch information
yuwen01 authored Nov 8, 2024
1 parent d277a14 commit 4503ebd
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion book/developers/common-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ This is likely due to two different versions of `alloy_sol_types` being used. To

```toml
[dependencies]
sp1-sdk = { version = "2.0.0", default-features = false }
sp1-sdk = { version = "3.0.0", default-features = false }
```

This will configure out the `network` feature which will remove the dependency on `alloy_sol_types` and configure out the `NetworkProver`.
Expand Down
2 changes: 1 addition & 1 deletion book/generating-proofs/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ RUSTFLAGS='-C target-cpu=native' cargo run --release
Currently there is support for AVX512 and NEON SIMD instructions. For NEON, you must also enable the `sp1-sdk` feature `neon` in your script crate's `Cargo.toml` file.

```toml
sp1-sdk = { version = "2.0.0", features = ["neon"] }
sp1-sdk = { version = "3.0.0", features = ["neon"] }
```

## Performance
Expand Down
2 changes: 1 addition & 1 deletion book/generating-proofs/proof-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ There are a few different types of proofs that can be generated by the SP1 zkVM.

The `ProverClient` follows a "builder" pattern that allows you to configure the proof type and other options after creating a `ProverClient` and calling `prove` on it.

For a full list of options, see the following [docs](https://docs.rs/sp1-sdk/1.2.0/sp1_sdk/action/struct.Prove.html).
For a full list of options, see the following [docs](https://docs.rs/sp1-sdk/latest/sp1_sdk/action/struct.Prove.html).

## Core (Default)

Expand Down
8 changes: 4 additions & 4 deletions book/verification/off-chain-verification.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ the [Groth16 Example](https://github.com/succinctlabs/sp1/tree/main/examples/gro

### Installation

Import the following dependency in your `Cargo.toml`:
Import the following dependency in your `Cargo.toml`. Note that the `sp1-verifier` crate was added in version `3.2.1`.

```toml
sp1-verifier = {version = "3.0.0", default-features = false}
sp1-verifier = {version = "3.2.1", default-features = false}
```

### Usage

`sp1-verifier`'s interface is very similar to the solidity verifier's. It exposes two public functions:
[`Groth16Verifier::verify_proof`](https://docs.rs/sp1-verifier/latest/src/sp1_verifier/groth16.rs.html)
and [`PlonkVerifier::verify_proof`](https://docs.rs/sp1-verifier/latest/src/sp1_verifier/plonk.rs.html).
[`Groth16Verifier::verify_proof`](https://docs.rs/sp1-verifier/latest/sp1_verifier/struct.Groth16Verifier.html)
and [`PlonkVerifier::verify_proof`](https://docs.rs/sp1-verifier/latest/sp1_verifier/struct.PlonkVerifier.html).

`sp1-verifier` also exposes the Groth16 and Plonk verifying keys as constants, `GROTH16_VK_BYTES` and `PLONK_VK_BYTES`. These
keys correspond to the current SP1 version's official Groth16 and Plonk verifying keys, which are used for verifying proofs generated
Expand Down
2 changes: 1 addition & 1 deletion book/verification/onchain/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ You can run the above script with `RUST_LOG=info cargo run --bin groth16_bn254 -
If you would like to run the Groth16 or PLONK prover directly without Docker, you must have Go 1.22 installed and enable the `native-gnark` feature in `sp1-sdk`. This path is not recommended and may require additional native dependencies.

```toml
sp1-sdk = { version = "2.0.0", features = ["native-gnark"] }
sp1-sdk = { version = "3.0.0", features = ["native-gnark"] }
```
4 changes: 2 additions & 2 deletions book/writing-programs/compiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The path passed in to `build_program` should point to the directory containing t

```toml
[build-dependencies]
sp1-build = "2.0.0"
sp1-build = "3.0.0"
```

You will see output like the following from the build script if the program has changed, indicating that the program was rebuilt:
Expand All @@ -80,7 +80,7 @@ The above output was generated by running `RUST_LOG=info cargo run --release -vv

### Advanced Build Options

To configure the build process when using the `sp1-build` crate, you can pass a [`BuildArgs`](https://docs.rs/sp1-build/1.2.0/sp1_build/struct.BuildArgs.html) struct to to the [`build_program_with_args`](https://docs.rs/sp1-build/1.2.0/sp1_build/fn.build_program_with_args.html) function. The build arguments are the same as the ones available from the `cargo prove build` command.
To configure the build process when using the `sp1-build` crate, you can pass a [`BuildArgs`](https://docs.rs/sp1-build/latest/sp1_build/struct.BuildArgs.html) struct to to the [`build_program_with_args`](https://docs.rs/sp1-build/latest/sp1_build/fn.build_program_with_args.html) function. The build arguments are the same as the ones available from the `cargo prove build` command.

As an example, you could use the following code to build the Fibonacci example with the `docker` flag set to `true` and a custom output directory for the generated ELF:

Expand Down
2 changes: 1 addition & 1 deletion book/writing-programs/cycle-tracking.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Note that to use the macro, you must add the `sp1-derive` crate to your dependen

```toml
[dependencies]
sp1-derive = "2.0.0"
sp1-derive = "3.0.0"
```

In the script for proof generation, setup the logger with `utils::setup_logger()` and run the script with `RUST_LOG=info cargo run --release`. You should see the following output:
Expand Down

0 comments on commit 4503ebd

Please sign in to comment.