From 4503ebda58adc82452dae48a5d57fd7752da1d40 Mon Sep 17 00:00:00 2001 From: Yuwen Zhang Date: Thu, 7 Nov 2024 19:26:29 -0800 Subject: [PATCH] docs: version nits (#1774) --- book/developers/common-issues.md | 2 +- book/generating-proofs/advanced.md | 2 +- book/generating-proofs/proof-types.md | 2 +- book/verification/off-chain-verification.md | 8 ++++---- book/verification/onchain/getting-started.md | 2 +- book/writing-programs/compiling.md | 4 ++-- book/writing-programs/cycle-tracking.md | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/book/developers/common-issues.md b/book/developers/common-issues.md index 5d0a50e808..5b06ec3b43 100644 --- a/book/developers/common-issues.md +++ b/book/developers/common-issues.md @@ -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`. diff --git a/book/generating-proofs/advanced.md b/book/generating-proofs/advanced.md index 4b1f30c544..76f8ac67d5 100644 --- a/book/generating-proofs/advanced.md +++ b/book/generating-proofs/advanced.md @@ -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 diff --git a/book/generating-proofs/proof-types.md b/book/generating-proofs/proof-types.md index d256f2b771..72dd9a41cd 100644 --- a/book/generating-proofs/proof-types.md +++ b/book/generating-proofs/proof-types.md @@ -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) diff --git a/book/verification/off-chain-verification.md b/book/verification/off-chain-verification.md index 9250b6021a..3dd4bc601f 100644 --- a/book/verification/off-chain-verification.md +++ b/book/verification/off-chain-verification.md @@ -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 diff --git a/book/verification/onchain/getting-started.md b/book/verification/onchain/getting-started.md index 834a23dc18..8519d620a8 100644 --- a/book/verification/onchain/getting-started.md +++ b/book/verification/onchain/getting-started.md @@ -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"] } ``` diff --git a/book/writing-programs/compiling.md b/book/writing-programs/compiling.md index f1acd49b0d..6a1fdc56b4 100644 --- a/book/writing-programs/compiling.md +++ b/book/writing-programs/compiling.md @@ -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: @@ -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: diff --git a/book/writing-programs/cycle-tracking.md b/book/writing-programs/cycle-tracking.md index c560f28ae5..e7168c5723 100644 --- a/book/writing-programs/cycle-tracking.md +++ b/book/writing-programs/cycle-tracking.md @@ -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: