Skip to content

Commit c62acc2

Browse files
pdg744nategrafflaub
authored
sidebar reorganization (risc0#1468)
This PR mostly just moves content around in order to make the conceptual flow clearer. Rather than looking at the diff in GitHub, I suggest reviewing by opening the deployment, imagining yourself as a new user, and trying it out. The high-level thinking around the conceptual flow for users is described in this diagram: <img width="1046" alt="image" src="https://github.com/risc0/risc0/assets/15272444/08f89eee-adc6-48da-acf2-b905475f9ce2"> - [ ] This PR moves the `bonsai/quickstart.md` doc to `generating-proofs/remote-proving.md`. If we use this organization, we need to set up a re-direct so that the QR codes and outstanding links that point to `bonsai/quickstart` don't 404. - [ ] This PR deletes the `bonsai/overview.md` doc. We need to set up a re-direct so that QR codes and outstanding links that point to `bonsai/` don't 404. The redirect should point to `generating-proofs/remote-proving.md` <s>This PR also drops the slug on the `zkvm_overview` doc, which means links to `/zkvm/` will 404. If we want to drop this slug, we should set up a re-direct from `/zkvm/` to `/zkvm/zkvm_overview.md` to address this. </s> resolved by keeping the slug --------- Co-authored-by: Victor Graf <[email protected]> Co-authored-by: Frank Laub <[email protected]> Co-authored-by: Frank Laub <[email protected]>
1 parent 3c4ea6c commit c62acc2

18 files changed

+308
-387
lines changed

website/api/bonsai/bonsai-on-eth.md renamed to website/api/blockchain-integration/bonsai-on-eth.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
_Warning: The zkVM and Bonsai are still in development. Do not use in production._
44

5-
Prove computation with the [RISC Zero zkVM](../zkvm) and verify the results in your Ethereum contract.
5+
Prove computation with the [RISC Zero zkVM](../zkvm/zkvm_overview.md) and verify the results in your Ethereum contract.
66

77
The zkVM and Bonsai together can act as a [coprocessor][coprocessor-article] to the smart contract application.
88
This unlocks powerful new applications on Ethereum that offload computationally intensive (i.e. gas expensive) and difficult to implement (e.g. ed25519 signature verification, or HTML parsing) functions to the zkVM.

website/api/bonsai/blockchain-zkvm-guide.md

-59
This file was deleted.

website/api/bonsai/bonsai-overview.md

-70
This file was deleted.

website/api/bonsai/quickstart.md

-24
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Local Proving
2+
3+
RISC Zero offers a fully [open-source] prover.
4+
Users can run the [zkVM] locally, generating proofs using their own hardware.
5+
The [feature flags] include options to toggle between CPU and GPU proving.
6+
7+
## Local vs. Remote Proving
8+
9+
For most use cases, we recommend remote proving using [Bonsai].
10+
The primary reason to consider using local proof generation for your application is to manage private data.
11+
12+
> Whoever is generating the proofs can see all private information involved.
13+
14+
_With local proof generation, you can generate proofs about your private data, while your private data never leaves your machine._
15+
16+
[open-source]: https://risczero.com/news/open-source
17+
[zkVM]: ../zkvm/zkvm_overview.md
18+
[feature flags]: https://github.com/risc0/risc0#feature-flags
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Options for Proof Generation
2+
3+
To support a variety of use cases, RISC Zero allows users a variety of options for proof generation.
4+
5+
Users can choose between:
6+
7+
1. [dev-mode]: No proofs are generated, enabling rapid prototyping.
8+
2. [Local Proving]: Proofs are generated on the user's own CPU/GPU.
9+
3. [Remote Proving]: Proofs are generated by [Bonsai], a highly parallelized, highly performant proving service.
10+
11+
We recommend option 1 during development, option 2 for applications involving private inputs, and option 3 for all other applications.
12+
13+
[dev-mode]: ./dev-mode
14+
[Local Proving]: ./local-proving
15+
[Remote Proving]: ./remote-proving
16+
[Bonsai]: https://bonsai.xyz
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Remote Proving using Bonsai
2+
3+
Bonsai lets users generate proofs for their zkVM applications, without using their own hardware for proof generation.
4+
Users specify which zkVM application they want to run, as well as the inputs to that program, and Bonsai returns a proof.
5+
6+
Bonsai is highly parallelized and highly performant: proving work on Bonsai is split among a dynamically-sized GPU cluster, offering ultra-fast proving.
7+
To get a taste of what you can do with Bonsai, check out [Zeth], our [Governance Showcase], [Bonsai Pay], and our twitter thread about using [Bonsai as a zk coprocessor].
8+
9+
If you already have an API key, you can request proofs from Bonsai in any of the following ways:
10+
11+
- via **[cargo risczero]** (great for experimenting or for non-blockchain applications)
12+
- Enable Bonsai by setting the environment variables `BONSAI_API_KEY=<YOUR_API_KEY>` and `BONSAI_API_URL=<BONSAI_URL>` when running your program
13+
- via the **[Bonsai Foundry Template]** (for accessing Bonsai via Ethereum)
14+
- via the **[Bonsai SDK]** (for accessing Bonsai from Rust)
15+
- via the **[Bonsai REST API]** (for building your own client or accessing Bonsai directly)
16+
17+
If you don't have an API key, you can [request access].
18+
While you wait, you can make use of the local proving option on the Bonsai Foundry Template, or you can focus on developing for the [zkVM].
19+
20+
[litepaper]: /litepaper
21+
[request access]: https://bonsai.xyz/apply
22+
[Bonsai SDK]: https://crates.io/crates/bonsai-sdk
23+
[Bonsai REST API]: https://api.bonsai.xyz/swagger-ui/
24+
[Bonsai as a zk coprocessor]: https://twitter.com/RiscZero/status/1677316664772132864
25+
[Governance Showcase]: https://github.com/risc0/risc0/tree/main/bonsai/examples/governance#readme
26+
[Zeth]: https://www.risczero.com/news/zeth-release
27+
[guest program]: /terminology#guest-program
28+
[receipt]: /terminology#receipt
29+
[journal]: /terminology#journal
30+
[Bonsai Pay]: https://www.risczero.com/news/bonsai-pay
31+
[Bonsai Foundry Template]: https://github.com/risc0/bonsai-foundry-template/blob/main/README.md
32+
[cargo risczero]: https://crates.io/crates/cargo-risczero
33+
[zkVM]: ../zkvm/zkvm_overview.md

website/api/getting-started.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Getting Started
2+
3+
To harness the power of ZK, you'll need to:
4+
5+
1. [Write an application for the RISC Zero zkVM][zkvm-quickstart].
6+
2. [Generate proofs for your zkVM application][bonsai-quickstart].
7+
3. [Integrate your proofs into on-chain applications][bonsai-on-eth].
8+
9+
```mermaid
10+
11+
flowchart TD
12+
%% Level 0
13+
getting_started["Getting Started
14+
To use the zkVM and/or Bonsai for blockchain applications, users will need to:
15+
1. Build a zkVM app.
16+
2. Generate proofs for their zkVM app.
17+
3. Integrate proofs into blockchain applications."]
18+
19+
20+
21+
zkvm_app["1. zkVM Application Development"]
22+
zkvm_quickstart["zkVM Quickstart"]
23+
proof_generation["2. Generating proofs for your zkVM application"]
24+
25+
chain_integration["3. Blockchain Integration"]
26+
getting_proofs_on_chain["Post proofs on-chain"]
27+
onchain_verifier["Call our on-chain verifier"]
28+
29+
30+
dev_mode["Dev Mode
31+
- Skips proving enabling fast prototyping"]
32+
local_proving["Local Proving
33+
- Made possible by open-source tech
34+
- Important for privacy applications"]
35+
remote_proving["Remote Proving
36+
- Bonsai is a scalable proving service, <br/>ready to generate proofs as needed."]
37+
38+
39+
40+
getting_started --> zkvm_app
41+
zkvm_app --> zkvm_quickstart
42+
getting_started --> proof_generation
43+
proof_generation --> dev_mode
44+
proof_generation --> local_proving
45+
proof_generation --> remote_proving
46+
getting_started --> chain_integration
47+
chain_integration --> getting_proofs_on_chain
48+
chain_integration --> onchain_verifier
49+
50+
51+
52+
53+
```
54+
55+
[zkvm-quickstart]: ./zkvm/quickstart.md
56+
[bonsai-quickstart]: ./generating-proofs/proving-options.md
57+
[bonsai-on-eth]: ./blockchain-integration/bonsai-on-eth.md

0 commit comments

Comments
 (0)