Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into victor/update-bonsai-…
Browse files Browse the repository at this point in the history
…libs
  • Loading branch information
nategraf committed Aug 2, 2023
2 parents f1bbb61 + 551c80d commit 75b15fe
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 0 deletions.
5 changes: 5 additions & 0 deletions contracts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bonsai Solidity Contracts

This folder contains the Solidity contract for deploying a Bonsai application through the Ethereum relay.

The contract demonstrates one pattern for offloading the computation of an expensive or difficult to implement function to a RISC Zero guest running on Bonsai.
11 changes: 11 additions & 0 deletions methods/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## zkVM Methods

This folder contains the [zkVM] portion of your [Bonsai] application.
In typical use cases, you will only need to edit the code inside `guest/src/bin` which is where you write the source code for your [guest program].

To learn more about the architecture of Bonsai apps and zkVM apps, check out the [developer documentation]. Note that the Bonsai Ethereum Relay acts as the zkVM host and so you do not need to write zkVM host code yourself.

[guest program]: https://dev.risczero.com/terminology#guest-program
[developer documentation]: https://dev.risczero.com
[zkVM]: https://dev.risczero.com/zkvm
[Bonsai]: https://dev.risczero.com/bonsai/
7 changes: 7 additions & 0 deletions methods/guest/src/bin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Guest Methods

Each file in this folder will be compiled to an ELF file, and the execution of the resulting ELF file will be proven by the zkVM.

To learn more about guest methods, check out the zkVM [developer docs].

[developer docs]: https://dev.risczero.com/zkvm

0 comments on commit 75b15fe

Please sign in to comment.