mirror of
https://github.com/logos-blockchain/lssa-zkvm-testing.git
synced 2026-01-04 14:23:08 +00:00
Merge 60f8046b36ab2f86da9fea7506224b3d40eb6345 into 48370d4e22dd3864570f72bf74b5c4a0becfe5fc
This commit is contained in:
commit
2ee0127aaa
11
risc0/ped_bls12_381_test/Cargo.toml
Normal file
11
risc0/ped_bls12_381_test/Cargo.toml
Normal file
@ -0,0 +1,11 @@
|
||||
[workspace]
|
||||
resolver = "2"
|
||||
members = ["host", "methods"]
|
||||
|
||||
# Always optimize; building and running the guest takes much longer without optimization.
|
||||
[profile.dev]
|
||||
opt-level = 3
|
||||
|
||||
[profile.release]
|
||||
debug = 1
|
||||
lto = true
|
||||
201
risc0/ped_bls12_381_test/LICENSE
Normal file
201
risc0/ped_bls12_381_test/LICENSE
Normal file
@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
111
risc0/ped_bls12_381_test/README.md
Normal file
111
risc0/ped_bls12_381_test/README.md
Normal file
@ -0,0 +1,111 @@
|
||||
# RISC Zero Rust Starter Template
|
||||
|
||||
Welcome to the RISC Zero Rust Starter Template! This template is intended to
|
||||
give you a starting point for building a project using the RISC Zero zkVM.
|
||||
Throughout the template (including in this README), you'll find comments
|
||||
labelled `TODO` in places where you'll need to make changes. To better
|
||||
understand the concepts behind this template, check out the [zkVM
|
||||
Overview][zkvm-overview].
|
||||
|
||||
## Quick Start
|
||||
|
||||
First, make sure [rustup] is installed. The
|
||||
[`rust-toolchain.toml`][rust-toolchain] file will be used by `cargo` to
|
||||
automatically install the correct version.
|
||||
|
||||
To build all methods and execute the method within the zkVM, run the following
|
||||
command:
|
||||
|
||||
```bash
|
||||
cargo run
|
||||
```
|
||||
|
||||
This is an empty template, and so there is no expected output (until you modify
|
||||
the code).
|
||||
|
||||
### Executing the Project Locally in Development Mode
|
||||
|
||||
During development, faster iteration upon code changes can be achieved by leveraging [dev-mode], we strongly suggest activating it during your early development phase. Furthermore, you might want to get insights into the execution statistics of your project, and this can be achieved by specifying the environment variable `RUST_LOG="[executor]=info"` before running your project.
|
||||
|
||||
Put together, the command to run your project in development mode while getting execution statistics is:
|
||||
|
||||
```bash
|
||||
RUST_LOG="[executor]=info" RISC0_DEV_MODE=1 cargo run
|
||||
```
|
||||
|
||||
### Running Proofs Remotely on Bonsai
|
||||
|
||||
_Note: The Bonsai proving service is still in early Alpha; an API key is
|
||||
required for access. [Click here to request access][bonsai access]._
|
||||
|
||||
If you have access to the URL and API key to Bonsai you can run your proofs
|
||||
remotely. To prove in Bonsai mode, invoke `cargo run` with two additional
|
||||
environment variables:
|
||||
|
||||
```bash
|
||||
BONSAI_API_KEY="YOUR_API_KEY" BONSAI_API_URL="BONSAI_URL" cargo run
|
||||
```
|
||||
|
||||
## How to Create a Project Based on This Template
|
||||
|
||||
Search this template for the string `TODO`, and make the necessary changes to
|
||||
implement the required feature described by the `TODO` comment. Some of these
|
||||
changes will be complex, and so we have a number of instructional resources to
|
||||
assist you in learning how to write your own code for the RISC Zero zkVM:
|
||||
|
||||
- The [RISC Zero Developer Docs][dev-docs] is a great place to get started.
|
||||
- Example projects are available in the [examples folder][examples] of
|
||||
[`risc0`][risc0-repo] repository.
|
||||
- Reference documentation is available at [https://docs.rs][docs.rs], including
|
||||
[`risc0-zkvm`][risc0-zkvm], [`cargo-risczero`][cargo-risczero],
|
||||
[`risc0-build`][risc0-build], and [others][crates].
|
||||
|
||||
## Directory Structure
|
||||
|
||||
It is possible to organize the files for these components in various ways.
|
||||
However, in this starter template we use a standard directory structure for zkVM
|
||||
applications, which we think is a good starting point for your applications.
|
||||
|
||||
```text
|
||||
project_name
|
||||
├── Cargo.toml
|
||||
├── host
|
||||
│ ├── Cargo.toml
|
||||
│ └── src
|
||||
│ └── main.rs <-- [Host code goes here]
|
||||
└── methods
|
||||
├── Cargo.toml
|
||||
├── build.rs
|
||||
├── guest
|
||||
│ ├── Cargo.toml
|
||||
│ └── src
|
||||
│ └── method_name.rs <-- [Guest code goes here]
|
||||
└── src
|
||||
└── lib.rs
|
||||
```
|
||||
|
||||
## Video Tutorial
|
||||
|
||||
For a walk-through of how to build with this template, check out this [excerpt
|
||||
from our workshop at ZK HACK III][zkhack-iii].
|
||||
|
||||
## Questions, Feedback, and Collaborations
|
||||
|
||||
We'd love to hear from you on [Discord][discord] or [Twitter][twitter].
|
||||
|
||||
[bonsai access]: https://bonsai.xyz/apply
|
||||
[cargo-risczero]: https://docs.rs/cargo-risczero
|
||||
[crates]: https://github.com/risc0/risc0/blob/main/README.md#rust-binaries
|
||||
[dev-docs]: https://dev.risczero.com
|
||||
[dev-mode]: https://dev.risczero.com/api/generating-proofs/dev-mode
|
||||
[discord]: https://discord.gg/risczero
|
||||
[docs.rs]: https://docs.rs/releases/search?query=risc0
|
||||
[examples]: https://github.com/risc0/risc0/tree/main/examples
|
||||
[risc0-build]: https://docs.rs/risc0-build
|
||||
[risc0-repo]: https://www.github.com/risc0/risc0
|
||||
[risc0-zkvm]: https://docs.rs/risc0-zkvm
|
||||
[rust-toolchain]: rust-toolchain.toml
|
||||
[rustup]: https://rustup.rs
|
||||
[twitter]: https://twitter.com/risczero
|
||||
[zkhack-iii]: https://www.youtube.com/watch?v=Yg_BGqj_6lg&list=PLcPzhUaCxlCgig7ofeARMPwQ8vbuD6hC5&index=5
|
||||
[zkvm-overview]: https://dev.risczero.com/zkvm
|
||||
10
risc0/ped_bls12_381_test/host/Cargo.toml
Normal file
10
risc0/ped_bls12_381_test/host/Cargo.toml
Normal file
@ -0,0 +1,10 @@
|
||||
[package]
|
||||
name = "host"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[dependencies]
|
||||
methods = { path = "../methods" }
|
||||
risc0-zkvm = { version = "^2.1.0" }
|
||||
tracing-subscriber = { version = "0.3", features = ["env-filter"] }
|
||||
serde = "1.0"
|
||||
56
risc0/ped_bls12_381_test/host/src/main.rs
Normal file
56
risc0/ped_bls12_381_test/host/src/main.rs
Normal file
@ -0,0 +1,56 @@
|
||||
// These constants represent the RISC-V ELF and the image ID generated by risc0-build.
|
||||
// The ELF is used for proving and the ID is used for verification.
|
||||
use methods::{
|
||||
PED_BLS12_381_GUEST_ELF, PED_BLS12_381_GUEST_ID
|
||||
};
|
||||
use risc0_zkvm::{default_prover, ExecutorEnv};
|
||||
|
||||
fn main() {
|
||||
// Initialize tracing. In order to view logs, run `RUST_LOG=info cargo run`
|
||||
tracing_subscriber::fmt()
|
||||
.with_env_filter(tracing_subscriber::filter::EnvFilter::from_default_env())
|
||||
.init();
|
||||
|
||||
// An executor environment describes the configurations for the zkVM
|
||||
// including program inputs.
|
||||
// A default ExecutorEnv can be created like so:
|
||||
// `let env = ExecutorEnv::builder().build().unwrap();`
|
||||
// However, this `env` does not have any inputs.
|
||||
//
|
||||
// To add guest input to the executor environment, use
|
||||
// ExecutorEnvBuilder::write().
|
||||
// To access this method, you'll need to use ExecutorEnv::builder(), which
|
||||
// creates an ExecutorEnvBuilder. When you're done adding input, call
|
||||
// ExecutorEnvBuilder::build().
|
||||
|
||||
// For example:
|
||||
let input: u32 = 15 * u32::pow(2, 27) + 1;
|
||||
let env = ExecutorEnv::builder()
|
||||
.write(&input)
|
||||
.unwrap()
|
||||
.build()
|
||||
.unwrap();
|
||||
|
||||
// Obtain the default prover.
|
||||
let prover = default_prover();
|
||||
|
||||
// Proof information by proving the specified ELF binary.
|
||||
// This struct contains the receipt along with statistics about execution of the guest
|
||||
let prove_info = prover
|
||||
.prove(env, PED_BLS12_381_GUEST_ELF)
|
||||
.unwrap();
|
||||
|
||||
// extract the receipt.
|
||||
let receipt = prove_info.receipt;
|
||||
|
||||
// TODO: Implement code for retrieving receipt journal here.
|
||||
|
||||
// For example:
|
||||
let _output: u32 = receipt.journal.decode().unwrap();
|
||||
|
||||
// The receipt was verified at the end of proving, but the below code is an
|
||||
// example of how someone else could verify this receipt.
|
||||
receipt
|
||||
.verify(PED_BLS12_381_GUEST_ID)
|
||||
.unwrap();
|
||||
}
|
||||
10
risc0/ped_bls12_381_test/methods/Cargo.toml
Normal file
10
risc0/ped_bls12_381_test/methods/Cargo.toml
Normal file
@ -0,0 +1,10 @@
|
||||
[package]
|
||||
name = "methods"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[build-dependencies]
|
||||
risc0-build = { version = "^2.1.2" }
|
||||
|
||||
[package.metadata.risc0]
|
||||
methods = ["guest"]
|
||||
3
risc0/ped_bls12_381_test/methods/build.rs
Normal file
3
risc0/ped_bls12_381_test/methods/build.rs
Normal file
@ -0,0 +1,3 @@
|
||||
fn main() {
|
||||
risc0_build::embed_methods();
|
||||
}
|
||||
11
risc0/ped_bls12_381_test/methods/guest/Cargo.toml
Normal file
11
risc0/ped_bls12_381_test/methods/guest/Cargo.toml
Normal file
@ -0,0 +1,11 @@
|
||||
[package]
|
||||
name = "ped_bls12_381_guest"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[workspace]
|
||||
|
||||
[dependencies]
|
||||
risc0-zkvm = { version = "^2.1.0", default-features = false, features = ['std'] }
|
||||
bls12_381 = "0.8.0"
|
||||
light-poseidon = "0.3.0"
|
||||
27
risc0/ped_bls12_381_test/methods/guest/src/main.rs
Normal file
27
risc0/ped_bls12_381_test/methods/guest/src/main.rs
Normal file
@ -0,0 +1,27 @@
|
||||
use risc0_zkvm::guest::env;
|
||||
|
||||
fn main() {
|
||||
// TODO: Implement your guest code here
|
||||
|
||||
// read the input
|
||||
let input: u32 = env::read();
|
||||
|
||||
// TODO: do something with the input
|
||||
let g1 = bls12_381::G1Affine::generator();
|
||||
let g1_proj = bls12_381::G1Projective::from(g1);
|
||||
let g2 = g1_proj + g1;
|
||||
let g3 = g1 + g2;
|
||||
let g4 = g1 + g3;
|
||||
let g5 = g1 + g4;
|
||||
|
||||
let s1 = bls12_381::Scalar::from(87329482u64);
|
||||
let s2 = bls12_381::Scalar::from(37264829u64);
|
||||
let s3 = bls12_381::Scalar::from(98098098u64);
|
||||
let s4 = bls12_381::Scalar::from(63980948u64);
|
||||
let s5 = bls12_381::Scalar::from(15098098u64);
|
||||
|
||||
let _ = s1*g1 + s2*g2 + s3*g3 + s4*g4 + s5*g5;
|
||||
|
||||
// write public output to the journal
|
||||
env::commit(&input);
|
||||
}
|
||||
1
risc0/ped_bls12_381_test/methods/src/lib.rs
Normal file
1
risc0/ped_bls12_381_test/methods/src/lib.rs
Normal file
@ -0,0 +1 @@
|
||||
include!(concat!(env!("OUT_DIR"), "/methods.rs"));
|
||||
4
risc0/ped_bls12_381_test/rust-toolchain.toml
Normal file
4
risc0/ped_bls12_381_test/rust-toolchain.toml
Normal file
@ -0,0 +1,4 @@
|
||||
[toolchain]
|
||||
channel = "stable"
|
||||
components = ["rustfmt", "rust-src"]
|
||||
profile = "minimal"
|
||||
11
risc0/ped_bn254_test/Cargo.toml
Normal file
11
risc0/ped_bn254_test/Cargo.toml
Normal file
@ -0,0 +1,11 @@
|
||||
[workspace]
|
||||
resolver = "2"
|
||||
members = ["host", "methods"]
|
||||
|
||||
# Always optimize; building and running the guest takes much longer without optimization.
|
||||
[profile.dev]
|
||||
opt-level = 3
|
||||
|
||||
[profile.release]
|
||||
debug = 1
|
||||
lto = true
|
||||
201
risc0/ped_bn254_test/LICENSE
Normal file
201
risc0/ped_bn254_test/LICENSE
Normal file
@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
111
risc0/ped_bn254_test/README.md
Normal file
111
risc0/ped_bn254_test/README.md
Normal file
@ -0,0 +1,111 @@
|
||||
# RISC Zero Rust Starter Template
|
||||
|
||||
Welcome to the RISC Zero Rust Starter Template! This template is intended to
|
||||
give you a starting point for building a project using the RISC Zero zkVM.
|
||||
Throughout the template (including in this README), you'll find comments
|
||||
labelled `TODO` in places where you'll need to make changes. To better
|
||||
understand the concepts behind this template, check out the [zkVM
|
||||
Overview][zkvm-overview].
|
||||
|
||||
## Quick Start
|
||||
|
||||
First, make sure [rustup] is installed. The
|
||||
[`rust-toolchain.toml`][rust-toolchain] file will be used by `cargo` to
|
||||
automatically install the correct version.
|
||||
|
||||
To build all methods and execute the method within the zkVM, run the following
|
||||
command:
|
||||
|
||||
```bash
|
||||
cargo run
|
||||
```
|
||||
|
||||
This is an empty template, and so there is no expected output (until you modify
|
||||
the code).
|
||||
|
||||
### Executing the Project Locally in Development Mode
|
||||
|
||||
During development, faster iteration upon code changes can be achieved by leveraging [dev-mode], we strongly suggest activating it during your early development phase. Furthermore, you might want to get insights into the execution statistics of your project, and this can be achieved by specifying the environment variable `RUST_LOG="[executor]=info"` before running your project.
|
||||
|
||||
Put together, the command to run your project in development mode while getting execution statistics is:
|
||||
|
||||
```bash
|
||||
RUST_LOG="[executor]=info" RISC0_DEV_MODE=1 cargo run
|
||||
```
|
||||
|
||||
### Running Proofs Remotely on Bonsai
|
||||
|
||||
_Note: The Bonsai proving service is still in early Alpha; an API key is
|
||||
required for access. [Click here to request access][bonsai access]._
|
||||
|
||||
If you have access to the URL and API key to Bonsai you can run your proofs
|
||||
remotely. To prove in Bonsai mode, invoke `cargo run` with two additional
|
||||
environment variables:
|
||||
|
||||
```bash
|
||||
BONSAI_API_KEY="YOUR_API_KEY" BONSAI_API_URL="BONSAI_URL" cargo run
|
||||
```
|
||||
|
||||
## How to Create a Project Based on This Template
|
||||
|
||||
Search this template for the string `TODO`, and make the necessary changes to
|
||||
implement the required feature described by the `TODO` comment. Some of these
|
||||
changes will be complex, and so we have a number of instructional resources to
|
||||
assist you in learning how to write your own code for the RISC Zero zkVM:
|
||||
|
||||
- The [RISC Zero Developer Docs][dev-docs] is a great place to get started.
|
||||
- Example projects are available in the [examples folder][examples] of
|
||||
[`risc0`][risc0-repo] repository.
|
||||
- Reference documentation is available at [https://docs.rs][docs.rs], including
|
||||
[`risc0-zkvm`][risc0-zkvm], [`cargo-risczero`][cargo-risczero],
|
||||
[`risc0-build`][risc0-build], and [others][crates].
|
||||
|
||||
## Directory Structure
|
||||
|
||||
It is possible to organize the files for these components in various ways.
|
||||
However, in this starter template we use a standard directory structure for zkVM
|
||||
applications, which we think is a good starting point for your applications.
|
||||
|
||||
```text
|
||||
project_name
|
||||
├── Cargo.toml
|
||||
├── host
|
||||
│ ├── Cargo.toml
|
||||
│ └── src
|
||||
│ └── main.rs <-- [Host code goes here]
|
||||
└── methods
|
||||
├── Cargo.toml
|
||||
├── build.rs
|
||||
├── guest
|
||||
│ ├── Cargo.toml
|
||||
│ └── src
|
||||
│ └── method_name.rs <-- [Guest code goes here]
|
||||
└── src
|
||||
└── lib.rs
|
||||
```
|
||||
|
||||
## Video Tutorial
|
||||
|
||||
For a walk-through of how to build with this template, check out this [excerpt
|
||||
from our workshop at ZK HACK III][zkhack-iii].
|
||||
|
||||
## Questions, Feedback, and Collaborations
|
||||
|
||||
We'd love to hear from you on [Discord][discord] or [Twitter][twitter].
|
||||
|
||||
[bonsai access]: https://bonsai.xyz/apply
|
||||
[cargo-risczero]: https://docs.rs/cargo-risczero
|
||||
[crates]: https://github.com/risc0/risc0/blob/main/README.md#rust-binaries
|
||||
[dev-docs]: https://dev.risczero.com
|
||||
[dev-mode]: https://dev.risczero.com/api/generating-proofs/dev-mode
|
||||
[discord]: https://discord.gg/risczero
|
||||
[docs.rs]: https://docs.rs/releases/search?query=risc0
|
||||
[examples]: https://github.com/risc0/risc0/tree/main/examples
|
||||
[risc0-build]: https://docs.rs/risc0-build
|
||||
[risc0-repo]: https://www.github.com/risc0/risc0
|
||||
[risc0-zkvm]: https://docs.rs/risc0-zkvm
|
||||
[rust-toolchain]: rust-toolchain.toml
|
||||
[rustup]: https://rustup.rs
|
||||
[twitter]: https://twitter.com/risczero
|
||||
[zkhack-iii]: https://www.youtube.com/watch?v=Yg_BGqj_6lg&list=PLcPzhUaCxlCgig7ofeARMPwQ8vbuD6hC5&index=5
|
||||
[zkvm-overview]: https://dev.risczero.com/zkvm
|
||||
10
risc0/ped_bn254_test/host/Cargo.toml
Normal file
10
risc0/ped_bn254_test/host/Cargo.toml
Normal file
@ -0,0 +1,10 @@
|
||||
[package]
|
||||
name = "host"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[dependencies]
|
||||
methods = { path = "../methods" }
|
||||
risc0-zkvm = { version = "^2.1.0" }
|
||||
tracing-subscriber = { version = "0.3", features = ["env-filter"] }
|
||||
serde = "1.0"
|
||||
56
risc0/ped_bn254_test/host/src/main.rs
Normal file
56
risc0/ped_bn254_test/host/src/main.rs
Normal file
@ -0,0 +1,56 @@
|
||||
// These constants represent the RISC-V ELF and the image ID generated by risc0-build.
|
||||
// The ELF is used for proving and the ID is used for verification.
|
||||
use methods::{
|
||||
PED_BN254_GUEST_ELF, PED_BN254_GUEST_ID
|
||||
};
|
||||
use risc0_zkvm::{default_prover, ExecutorEnv};
|
||||
|
||||
fn main() {
|
||||
// Initialize tracing. In order to view logs, run `RUST_LOG=info cargo run`
|
||||
tracing_subscriber::fmt()
|
||||
.with_env_filter(tracing_subscriber::filter::EnvFilter::from_default_env())
|
||||
.init();
|
||||
|
||||
// An executor environment describes the configurations for the zkVM
|
||||
// including program inputs.
|
||||
// A default ExecutorEnv can be created like so:
|
||||
// `let env = ExecutorEnv::builder().build().unwrap();`
|
||||
// However, this `env` does not have any inputs.
|
||||
//
|
||||
// To add guest input to the executor environment, use
|
||||
// ExecutorEnvBuilder::write().
|
||||
// To access this method, you'll need to use ExecutorEnv::builder(), which
|
||||
// creates an ExecutorEnvBuilder. When you're done adding input, call
|
||||
// ExecutorEnvBuilder::build().
|
||||
|
||||
// For example:
|
||||
let input: u32 = 15 * u32::pow(2, 27) + 1;
|
||||
let env = ExecutorEnv::builder()
|
||||
.write(&input)
|
||||
.unwrap()
|
||||
.build()
|
||||
.unwrap();
|
||||
|
||||
// Obtain the default prover.
|
||||
let prover = default_prover();
|
||||
|
||||
// Proof information by proving the specified ELF binary.
|
||||
// This struct contains the receipt along with statistics about execution of the guest
|
||||
let prove_info = prover
|
||||
.prove(env, PED_BN254_GUEST_ELF)
|
||||
.unwrap();
|
||||
|
||||
// extract the receipt.
|
||||
let receipt = prove_info.receipt;
|
||||
|
||||
// TODO: Implement code for retrieving receipt journal here.
|
||||
|
||||
// For example:
|
||||
let _output: u32 = receipt.journal.decode().unwrap();
|
||||
|
||||
// The receipt was verified at the end of proving, but the below code is an
|
||||
// example of how someone else could verify this receipt.
|
||||
receipt
|
||||
.verify(PED_BN254_GUEST_ID)
|
||||
.unwrap();
|
||||
}
|
||||
10
risc0/ped_bn254_test/methods/Cargo.toml
Normal file
10
risc0/ped_bn254_test/methods/Cargo.toml
Normal file
@ -0,0 +1,10 @@
|
||||
[package]
|
||||
name = "methods"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[build-dependencies]
|
||||
risc0-build = { version = "^2.1.2" }
|
||||
|
||||
[package.metadata.risc0]
|
||||
methods = ["guest"]
|
||||
3
risc0/ped_bn254_test/methods/build.rs
Normal file
3
risc0/ped_bn254_test/methods/build.rs
Normal file
@ -0,0 +1,3 @@
|
||||
fn main() {
|
||||
risc0_build::embed_methods();
|
||||
}
|
||||
11
risc0/ped_bn254_test/methods/guest/Cargo.toml
Normal file
11
risc0/ped_bn254_test/methods/guest/Cargo.toml
Normal file
@ -0,0 +1,11 @@
|
||||
[package]
|
||||
name = "ped_bn254_guest"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[workspace]
|
||||
|
||||
[dependencies]
|
||||
risc0-zkvm = { version = "^2.1.0", default-features = false, features = ['std'] }
|
||||
ark-bn254 = "0.5.0"
|
||||
ark-ec = "0.5.0"
|
||||
27
risc0/ped_bn254_test/methods/guest/src/main.rs
Normal file
27
risc0/ped_bn254_test/methods/guest/src/main.rs
Normal file
@ -0,0 +1,27 @@
|
||||
use risc0_zkvm::guest::env;
|
||||
use ark_ec::{CurveGroup, PrimeGroup};
|
||||
|
||||
fn main() {
|
||||
// TODO: Implement your guest code here
|
||||
|
||||
// read the input
|
||||
let input: u32 = env::read();
|
||||
|
||||
// TODO: do something with the input
|
||||
let g1 = ark_bn254::G1Projective::generator();
|
||||
let g2 = g1 + g1;
|
||||
let g3 = g1 + g2;
|
||||
let g4 = g1 + g3;
|
||||
let g5 = g1 + g4;
|
||||
|
||||
let s1 = ark_bn254::Fr::from(87329482u64);
|
||||
let s2 = ark_bn254::Fr::from(37264829u64);
|
||||
let s3 = ark_bn254::Fr::from(98098098u64);
|
||||
let s4 = ark_bn254::Fr::from(63980948u64);
|
||||
let s5 = ark_bn254::Fr::from(15098098u64);
|
||||
|
||||
let _ = (g1*s1 + g2*s2 + g3*s3 + g4*s4 + g5*s5).into_affine();
|
||||
|
||||
// write public output to the journal
|
||||
env::commit(&input);
|
||||
}
|
||||
1
risc0/ped_bn254_test/methods/src/lib.rs
Normal file
1
risc0/ped_bn254_test/methods/src/lib.rs
Normal file
@ -0,0 +1 @@
|
||||
include!(concat!(env!("OUT_DIR"), "/methods.rs"));
|
||||
4
risc0/ped_bn254_test/rust-toolchain.toml
Normal file
4
risc0/ped_bn254_test/rust-toolchain.toml
Normal file
@ -0,0 +1,4 @@
|
||||
[toolchain]
|
||||
channel = "stable"
|
||||
components = ["rustfmt", "rust-src"]
|
||||
profile = "minimal"
|
||||
11
risc0/ped_curve25519_test/Cargo.toml
Normal file
11
risc0/ped_curve25519_test/Cargo.toml
Normal file
@ -0,0 +1,11 @@
|
||||
[workspace]
|
||||
resolver = "2"
|
||||
members = ["host", "methods"]
|
||||
|
||||
# Always optimize; building and running the guest takes much longer without optimization.
|
||||
[profile.dev]
|
||||
opt-level = 3
|
||||
|
||||
[profile.release]
|
||||
debug = 1
|
||||
lto = true
|
||||
201
risc0/ped_curve25519_test/LICENSE
Normal file
201
risc0/ped_curve25519_test/LICENSE
Normal file
@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
111
risc0/ped_curve25519_test/README.md
Normal file
111
risc0/ped_curve25519_test/README.md
Normal file
@ -0,0 +1,111 @@
|
||||
# RISC Zero Rust Starter Template
|
||||
|
||||
Welcome to the RISC Zero Rust Starter Template! This template is intended to
|
||||
give you a starting point for building a project using the RISC Zero zkVM.
|
||||
Throughout the template (including in this README), you'll find comments
|
||||
labelled `TODO` in places where you'll need to make changes. To better
|
||||
understand the concepts behind this template, check out the [zkVM
|
||||
Overview][zkvm-overview].
|
||||
|
||||
## Quick Start
|
||||
|
||||
First, make sure [rustup] is installed. The
|
||||
[`rust-toolchain.toml`][rust-toolchain] file will be used by `cargo` to
|
||||
automatically install the correct version.
|
||||
|
||||
To build all methods and execute the method within the zkVM, run the following
|
||||
command:
|
||||
|
||||
```bash
|
||||
cargo run
|
||||
```
|
||||
|
||||
This is an empty template, and so there is no expected output (until you modify
|
||||
the code).
|
||||
|
||||
### Executing the Project Locally in Development Mode
|
||||
|
||||
During development, faster iteration upon code changes can be achieved by leveraging [dev-mode], we strongly suggest activating it during your early development phase. Furthermore, you might want to get insights into the execution statistics of your project, and this can be achieved by specifying the environment variable `RUST_LOG="[executor]=info"` before running your project.
|
||||
|
||||
Put together, the command to run your project in development mode while getting execution statistics is:
|
||||
|
||||
```bash
|
||||
RUST_LOG="[executor]=info" RISC0_DEV_MODE=1 cargo run
|
||||
```
|
||||
|
||||
### Running Proofs Remotely on Bonsai
|
||||
|
||||
_Note: The Bonsai proving service is still in early Alpha; an API key is
|
||||
required for access. [Click here to request access][bonsai access]._
|
||||
|
||||
If you have access to the URL and API key to Bonsai you can run your proofs
|
||||
remotely. To prove in Bonsai mode, invoke `cargo run` with two additional
|
||||
environment variables:
|
||||
|
||||
```bash
|
||||
BONSAI_API_KEY="YOUR_API_KEY" BONSAI_API_URL="BONSAI_URL" cargo run
|
||||
```
|
||||
|
||||
## How to Create a Project Based on This Template
|
||||
|
||||
Search this template for the string `TODO`, and make the necessary changes to
|
||||
implement the required feature described by the `TODO` comment. Some of these
|
||||
changes will be complex, and so we have a number of instructional resources to
|
||||
assist you in learning how to write your own code for the RISC Zero zkVM:
|
||||
|
||||
- The [RISC Zero Developer Docs][dev-docs] is a great place to get started.
|
||||
- Example projects are available in the [examples folder][examples] of
|
||||
[`risc0`][risc0-repo] repository.
|
||||
- Reference documentation is available at [https://docs.rs][docs.rs], including
|
||||
[`risc0-zkvm`][risc0-zkvm], [`cargo-risczero`][cargo-risczero],
|
||||
[`risc0-build`][risc0-build], and [others][crates].
|
||||
|
||||
## Directory Structure
|
||||
|
||||
It is possible to organize the files for these components in various ways.
|
||||
However, in this starter template we use a standard directory structure for zkVM
|
||||
applications, which we think is a good starting point for your applications.
|
||||
|
||||
```text
|
||||
project_name
|
||||
├── Cargo.toml
|
||||
├── host
|
||||
│ ├── Cargo.toml
|
||||
│ └── src
|
||||
│ └── main.rs <-- [Host code goes here]
|
||||
└── methods
|
||||
├── Cargo.toml
|
||||
├── build.rs
|
||||
├── guest
|
||||
│ ├── Cargo.toml
|
||||
│ └── src
|
||||
│ └── method_name.rs <-- [Guest code goes here]
|
||||
└── src
|
||||
└── lib.rs
|
||||
```
|
||||
|
||||
## Video Tutorial
|
||||
|
||||
For a walk-through of how to build with this template, check out this [excerpt
|
||||
from our workshop at ZK HACK III][zkhack-iii].
|
||||
|
||||
## Questions, Feedback, and Collaborations
|
||||
|
||||
We'd love to hear from you on [Discord][discord] or [Twitter][twitter].
|
||||
|
||||
[bonsai access]: https://bonsai.xyz/apply
|
||||
[cargo-risczero]: https://docs.rs/cargo-risczero
|
||||
[crates]: https://github.com/risc0/risc0/blob/main/README.md#rust-binaries
|
||||
[dev-docs]: https://dev.risczero.com
|
||||
[dev-mode]: https://dev.risczero.com/api/generating-proofs/dev-mode
|
||||
[discord]: https://discord.gg/risczero
|
||||
[docs.rs]: https://docs.rs/releases/search?query=risc0
|
||||
[examples]: https://github.com/risc0/risc0/tree/main/examples
|
||||
[risc0-build]: https://docs.rs/risc0-build
|
||||
[risc0-repo]: https://www.github.com/risc0/risc0
|
||||
[risc0-zkvm]: https://docs.rs/risc0-zkvm
|
||||
[rust-toolchain]: rust-toolchain.toml
|
||||
[rustup]: https://rustup.rs
|
||||
[twitter]: https://twitter.com/risczero
|
||||
[zkhack-iii]: https://www.youtube.com/watch?v=Yg_BGqj_6lg&list=PLcPzhUaCxlCgig7ofeARMPwQ8vbuD6hC5&index=5
|
||||
[zkvm-overview]: https://dev.risczero.com/zkvm
|
||||
10
risc0/ped_curve25519_test/host/Cargo.toml
Normal file
10
risc0/ped_curve25519_test/host/Cargo.toml
Normal file
@ -0,0 +1,10 @@
|
||||
[package]
|
||||
name = "host"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[dependencies]
|
||||
methods = { path = "../methods" }
|
||||
risc0-zkvm = { version = "^2.1.0" }
|
||||
tracing-subscriber = { version = "0.3", features = ["env-filter"] }
|
||||
serde = "1.0"
|
||||
56
risc0/ped_curve25519_test/host/src/main.rs
Normal file
56
risc0/ped_curve25519_test/host/src/main.rs
Normal file
@ -0,0 +1,56 @@
|
||||
// These constants represent the RISC-V ELF and the image ID generated by risc0-build.
|
||||
// The ELF is used for proving and the ID is used for verification.
|
||||
use methods::{
|
||||
PED_CURVE25519_GUEST_ELF, PED_CURVE25519_GUEST_ID
|
||||
};
|
||||
use risc0_zkvm::{default_prover, ExecutorEnv};
|
||||
|
||||
fn main() {
|
||||
// Initialize tracing. In order to view logs, run `RUST_LOG=info cargo run`
|
||||
tracing_subscriber::fmt()
|
||||
.with_env_filter(tracing_subscriber::filter::EnvFilter::from_default_env())
|
||||
.init();
|
||||
|
||||
// An executor environment describes the configurations for the zkVM
|
||||
// including program inputs.
|
||||
// A default ExecutorEnv can be created like so:
|
||||
// `let env = ExecutorEnv::builder().build().unwrap();`
|
||||
// However, this `env` does not have any inputs.
|
||||
//
|
||||
// To add guest input to the executor environment, use
|
||||
// ExecutorEnvBuilder::write().
|
||||
// To access this method, you'll need to use ExecutorEnv::builder(), which
|
||||
// creates an ExecutorEnvBuilder. When you're done adding input, call
|
||||
// ExecutorEnvBuilder::build().
|
||||
|
||||
// For example:
|
||||
let input: u32 = 15 * u32::pow(2, 27) + 1;
|
||||
let env = ExecutorEnv::builder()
|
||||
.write(&input)
|
||||
.unwrap()
|
||||
.build()
|
||||
.unwrap();
|
||||
|
||||
// Obtain the default prover.
|
||||
let prover = default_prover();
|
||||
|
||||
// Proof information by proving the specified ELF binary.
|
||||
// This struct contains the receipt along with statistics about execution of the guest
|
||||
let prove_info = prover
|
||||
.prove(env, PED_CURVE25519_GUEST_ELF)
|
||||
.unwrap();
|
||||
|
||||
// extract the receipt.
|
||||
let receipt = prove_info.receipt;
|
||||
|
||||
// TODO: Implement code for retrieving receipt journal here.
|
||||
|
||||
// For example:
|
||||
let _output: u32 = receipt.journal.decode().unwrap();
|
||||
|
||||
// The receipt was verified at the end of proving, but the below code is an
|
||||
// example of how someone else could verify this receipt.
|
||||
receipt
|
||||
.verify(PED_CURVE25519_GUEST_ID)
|
||||
.unwrap();
|
||||
}
|
||||
10
risc0/ped_curve25519_test/methods/Cargo.toml
Normal file
10
risc0/ped_curve25519_test/methods/Cargo.toml
Normal file
@ -0,0 +1,10 @@
|
||||
[package]
|
||||
name = "methods"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[build-dependencies]
|
||||
risc0-build = { version = "^2.1.2" }
|
||||
|
||||
[package.metadata.risc0]
|
||||
methods = ["guest"]
|
||||
3
risc0/ped_curve25519_test/methods/build.rs
Normal file
3
risc0/ped_curve25519_test/methods/build.rs
Normal file
@ -0,0 +1,3 @@
|
||||
fn main() {
|
||||
risc0_build::embed_methods();
|
||||
}
|
||||
11
risc0/ped_curve25519_test/methods/guest/Cargo.toml
Normal file
11
risc0/ped_curve25519_test/methods/guest/Cargo.toml
Normal file
@ -0,0 +1,11 @@
|
||||
[package]
|
||||
name = "ped_curve25519_guest"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[workspace]
|
||||
|
||||
[dependencies]
|
||||
risc0-zkvm = { version = "^2.1.0", default-features = false, features = ['std'] }
|
||||
curve25519-dalek = "4.1.2"
|
||||
|
||||
32
risc0/ped_curve25519_test/methods/guest/src/main.rs
Normal file
32
risc0/ped_curve25519_test/methods/guest/src/main.rs
Normal file
@ -0,0 +1,32 @@
|
||||
use risc0_zkvm::guest::env;
|
||||
use curve25519_dalek::constants;
|
||||
use curve25519_dalek::ristretto::RistrettoPoint;
|
||||
use curve25519_dalek::scalar::Scalar;
|
||||
use curve25519_dalek::traits::MultiscalarMul;
|
||||
|
||||
fn main() {
|
||||
// TODO: Implement your guest code here
|
||||
|
||||
// read the input
|
||||
let input: u32 = env::read();
|
||||
|
||||
// TODO: do something with the input
|
||||
let s1 = Scalar::from(87329482u64);
|
||||
let s2 = Scalar::from(37264829u64);
|
||||
let s3 = Scalar::from(98098098u64);
|
||||
let s4 = Scalar::from(63980948u64);
|
||||
let s5 = Scalar::from(15098098u64);
|
||||
|
||||
let g1 = constants::RISTRETTO_BASEPOINT_POINT;
|
||||
let g2 = g1 + g1;
|
||||
let g3 = g1 + g2;
|
||||
let g4 = g1 + g3;
|
||||
let g5 = g1 + g4;
|
||||
|
||||
let nums = [s1,s2,s3,s4,s5];
|
||||
|
||||
let _ = RistrettoPoint::multiscalar_mul(&nums, &[g1,g2,g3,g4,g5]);
|
||||
|
||||
// write public output to the journal
|
||||
env::commit(&input);
|
||||
}
|
||||
1
risc0/ped_curve25519_test/methods/src/lib.rs
Normal file
1
risc0/ped_curve25519_test/methods/src/lib.rs
Normal file
@ -0,0 +1 @@
|
||||
include!(concat!(env!("OUT_DIR"), "/methods.rs"));
|
||||
4
risc0/ped_curve25519_test/rust-toolchain.toml
Normal file
4
risc0/ped_curve25519_test/rust-toolchain.toml
Normal file
@ -0,0 +1,4 @@
|
||||
[toolchain]
|
||||
channel = "stable"
|
||||
components = ["rustfmt", "rust-src"]
|
||||
profile = "minimal"
|
||||
11
risc0/ped_jubjub_test/Cargo.toml
Normal file
11
risc0/ped_jubjub_test/Cargo.toml
Normal file
@ -0,0 +1,11 @@
|
||||
[workspace]
|
||||
resolver = "2"
|
||||
members = ["host", "methods"]
|
||||
|
||||
# Always optimize; building and running the guest takes much longer without optimization.
|
||||
[profile.dev]
|
||||
opt-level = 3
|
||||
|
||||
[profile.release]
|
||||
debug = 1
|
||||
lto = true
|
||||
201
risc0/ped_jubjub_test/LICENSE
Normal file
201
risc0/ped_jubjub_test/LICENSE
Normal file
@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
111
risc0/ped_jubjub_test/README.md
Normal file
111
risc0/ped_jubjub_test/README.md
Normal file
@ -0,0 +1,111 @@
|
||||
# RISC Zero Rust Starter Template
|
||||
|
||||
Welcome to the RISC Zero Rust Starter Template! This template is intended to
|
||||
give you a starting point for building a project using the RISC Zero zkVM.
|
||||
Throughout the template (including in this README), you'll find comments
|
||||
labelled `TODO` in places where you'll need to make changes. To better
|
||||
understand the concepts behind this template, check out the [zkVM
|
||||
Overview][zkvm-overview].
|
||||
|
||||
## Quick Start
|
||||
|
||||
First, make sure [rustup] is installed. The
|
||||
[`rust-toolchain.toml`][rust-toolchain] file will be used by `cargo` to
|
||||
automatically install the correct version.
|
||||
|
||||
To build all methods and execute the method within the zkVM, run the following
|
||||
command:
|
||||
|
||||
```bash
|
||||
cargo run
|
||||
```
|
||||
|
||||
This is an empty template, and so there is no expected output (until you modify
|
||||
the code).
|
||||
|
||||
### Executing the Project Locally in Development Mode
|
||||
|
||||
During development, faster iteration upon code changes can be achieved by leveraging [dev-mode], we strongly suggest activating it during your early development phase. Furthermore, you might want to get insights into the execution statistics of your project, and this can be achieved by specifying the environment variable `RUST_LOG="[executor]=info"` before running your project.
|
||||
|
||||
Put together, the command to run your project in development mode while getting execution statistics is:
|
||||
|
||||
```bash
|
||||
RUST_LOG="[executor]=info" RISC0_DEV_MODE=1 cargo run
|
||||
```
|
||||
|
||||
### Running Proofs Remotely on Bonsai
|
||||
|
||||
_Note: The Bonsai proving service is still in early Alpha; an API key is
|
||||
required for access. [Click here to request access][bonsai access]._
|
||||
|
||||
If you have access to the URL and API key to Bonsai you can run your proofs
|
||||
remotely. To prove in Bonsai mode, invoke `cargo run` with two additional
|
||||
environment variables:
|
||||
|
||||
```bash
|
||||
BONSAI_API_KEY="YOUR_API_KEY" BONSAI_API_URL="BONSAI_URL" cargo run
|
||||
```
|
||||
|
||||
## How to Create a Project Based on This Template
|
||||
|
||||
Search this template for the string `TODO`, and make the necessary changes to
|
||||
implement the required feature described by the `TODO` comment. Some of these
|
||||
changes will be complex, and so we have a number of instructional resources to
|
||||
assist you in learning how to write your own code for the RISC Zero zkVM:
|
||||
|
||||
- The [RISC Zero Developer Docs][dev-docs] is a great place to get started.
|
||||
- Example projects are available in the [examples folder][examples] of
|
||||
[`risc0`][risc0-repo] repository.
|
||||
- Reference documentation is available at [https://docs.rs][docs.rs], including
|
||||
[`risc0-zkvm`][risc0-zkvm], [`cargo-risczero`][cargo-risczero],
|
||||
[`risc0-build`][risc0-build], and [others][crates].
|
||||
|
||||
## Directory Structure
|
||||
|
||||
It is possible to organize the files for these components in various ways.
|
||||
However, in this starter template we use a standard directory structure for zkVM
|
||||
applications, which we think is a good starting point for your applications.
|
||||
|
||||
```text
|
||||
project_name
|
||||
├── Cargo.toml
|
||||
├── host
|
||||
│ ├── Cargo.toml
|
||||
│ └── src
|
||||
│ └── main.rs <-- [Host code goes here]
|
||||
└── methods
|
||||
├── Cargo.toml
|
||||
├── build.rs
|
||||
├── guest
|
||||
│ ├── Cargo.toml
|
||||
│ └── src
|
||||
│ └── method_name.rs <-- [Guest code goes here]
|
||||
└── src
|
||||
└── lib.rs
|
||||
```
|
||||
|
||||
## Video Tutorial
|
||||
|
||||
For a walk-through of how to build with this template, check out this [excerpt
|
||||
from our workshop at ZK HACK III][zkhack-iii].
|
||||
|
||||
## Questions, Feedback, and Collaborations
|
||||
|
||||
We'd love to hear from you on [Discord][discord] or [Twitter][twitter].
|
||||
|
||||
[bonsai access]: https://bonsai.xyz/apply
|
||||
[cargo-risczero]: https://docs.rs/cargo-risczero
|
||||
[crates]: https://github.com/risc0/risc0/blob/main/README.md#rust-binaries
|
||||
[dev-docs]: https://dev.risczero.com
|
||||
[dev-mode]: https://dev.risczero.com/api/generating-proofs/dev-mode
|
||||
[discord]: https://discord.gg/risczero
|
||||
[docs.rs]: https://docs.rs/releases/search?query=risc0
|
||||
[examples]: https://github.com/risc0/risc0/tree/main/examples
|
||||
[risc0-build]: https://docs.rs/risc0-build
|
||||
[risc0-repo]: https://www.github.com/risc0/risc0
|
||||
[risc0-zkvm]: https://docs.rs/risc0-zkvm
|
||||
[rust-toolchain]: rust-toolchain.toml
|
||||
[rustup]: https://rustup.rs
|
||||
[twitter]: https://twitter.com/risczero
|
||||
[zkhack-iii]: https://www.youtube.com/watch?v=Yg_BGqj_6lg&list=PLcPzhUaCxlCgig7ofeARMPwQ8vbuD6hC5&index=5
|
||||
[zkvm-overview]: https://dev.risczero.com/zkvm
|
||||
10
risc0/ped_jubjub_test/host/Cargo.toml
Normal file
10
risc0/ped_jubjub_test/host/Cargo.toml
Normal file
@ -0,0 +1,10 @@
|
||||
[package]
|
||||
name = "host"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[dependencies]
|
||||
methods = { path = "../methods" }
|
||||
risc0-zkvm = { version = "^2.1.0" }
|
||||
tracing-subscriber = { version = "0.3", features = ["env-filter"] }
|
||||
serde = "1.0"
|
||||
56
risc0/ped_jubjub_test/host/src/main.rs
Normal file
56
risc0/ped_jubjub_test/host/src/main.rs
Normal file
@ -0,0 +1,56 @@
|
||||
// These constants represent the RISC-V ELF and the image ID generated by risc0-build.
|
||||
// The ELF is used for proving and the ID is used for verification.
|
||||
use methods::{
|
||||
PED_JUBJUB_GUEST_ELF, PED_JUBJUB_GUEST_ID
|
||||
};
|
||||
use risc0_zkvm::{default_prover, ExecutorEnv};
|
||||
|
||||
fn main() {
|
||||
// Initialize tracing. In order to view logs, run `RUST_LOG=info cargo run`
|
||||
tracing_subscriber::fmt()
|
||||
.with_env_filter(tracing_subscriber::filter::EnvFilter::from_default_env())
|
||||
.init();
|
||||
|
||||
// An executor environment describes the configurations for the zkVM
|
||||
// including program inputs.
|
||||
// A default ExecutorEnv can be created like so:
|
||||
// `let env = ExecutorEnv::builder().build().unwrap();`
|
||||
// However, this `env` does not have any inputs.
|
||||
//
|
||||
// To add guest input to the executor environment, use
|
||||
// ExecutorEnvBuilder::write().
|
||||
// To access this method, you'll need to use ExecutorEnv::builder(), which
|
||||
// creates an ExecutorEnvBuilder. When you're done adding input, call
|
||||
// ExecutorEnvBuilder::build().
|
||||
|
||||
// For example:
|
||||
let input: u32 = 15 * u32::pow(2, 27) + 1;
|
||||
let env = ExecutorEnv::builder()
|
||||
.write(&input)
|
||||
.unwrap()
|
||||
.build()
|
||||
.unwrap();
|
||||
|
||||
// Obtain the default prover.
|
||||
let prover = default_prover();
|
||||
|
||||
// Proof information by proving the specified ELF binary.
|
||||
// This struct contains the receipt along with statistics about execution of the guest
|
||||
let prove_info = prover
|
||||
.prove(env, PED_JUBJUB_GUEST_ELF)
|
||||
.unwrap();
|
||||
|
||||
// extract the receipt.
|
||||
let receipt = prove_info.receipt;
|
||||
|
||||
// TODO: Implement code for retrieving receipt journal here.
|
||||
|
||||
// For example:
|
||||
let _output: u32 = receipt.journal.decode().unwrap();
|
||||
|
||||
// The receipt was verified at the end of proving, but the below code is an
|
||||
// example of how someone else could verify this receipt.
|
||||
receipt
|
||||
.verify(PED_JUBJUB_GUEST_ID)
|
||||
.unwrap();
|
||||
}
|
||||
10
risc0/ped_jubjub_test/methods/Cargo.toml
Normal file
10
risc0/ped_jubjub_test/methods/Cargo.toml
Normal file
@ -0,0 +1,10 @@
|
||||
[package]
|
||||
name = "methods"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[build-dependencies]
|
||||
risc0-build = { version = "^2.1.2" }
|
||||
|
||||
[package.metadata.risc0]
|
||||
methods = ["guest"]
|
||||
3
risc0/ped_jubjub_test/methods/build.rs
Normal file
3
risc0/ped_jubjub_test/methods/build.rs
Normal file
@ -0,0 +1,3 @@
|
||||
fn main() {
|
||||
risc0_build::embed_methods();
|
||||
}
|
||||
11
risc0/ped_jubjub_test/methods/guest/Cargo.toml
Normal file
11
risc0/ped_jubjub_test/methods/guest/Cargo.toml
Normal file
@ -0,0 +1,11 @@
|
||||
[package]
|
||||
name = "ped_jubjub_guest"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[workspace]
|
||||
|
||||
[dependencies]
|
||||
risc0-zkvm = { version = "^2.1.0", default-features = false, features = ['std'] }
|
||||
jubjub = "0.10.0"
|
||||
group = "0.13.0"
|
||||
27
risc0/ped_jubjub_test/methods/guest/src/main.rs
Normal file
27
risc0/ped_jubjub_test/methods/guest/src/main.rs
Normal file
@ -0,0 +1,27 @@
|
||||
use risc0_zkvm::guest::env;
|
||||
use group::Group;
|
||||
|
||||
fn main() {
|
||||
// TODO: Implement your guest code here
|
||||
|
||||
// read the input
|
||||
let input: u32 = env::read();
|
||||
|
||||
// TODO: do something with the input
|
||||
let g1 = jubjub::SubgroupPoint::generator();
|
||||
let g2 = g1 + g1;
|
||||
let g3 = g1 + g2;
|
||||
let g4 = g1 + g3;
|
||||
let g5 = g1 + g4;
|
||||
|
||||
let s1 = jubjub::Fr::from(87329482u64);
|
||||
let s2 = jubjub::Fr::from(37264829u64);
|
||||
let s3 = jubjub::Fr::from(98098098u64);
|
||||
let s4 = jubjub::Fr::from(63980948u64);
|
||||
let s5 = jubjub::Fr::from(15098098u64);
|
||||
|
||||
let _ = g1*s1 + g2*s2 + g3*s3 + g4*s4 + g5*s5;
|
||||
|
||||
// write public output to the journal
|
||||
env::commit(&input);
|
||||
}
|
||||
1
risc0/ped_jubjub_test/methods/src/lib.rs
Normal file
1
risc0/ped_jubjub_test/methods/src/lib.rs
Normal file
@ -0,0 +1 @@
|
||||
include!(concat!(env!("OUT_DIR"), "/methods.rs"));
|
||||
4
risc0/ped_jubjub_test/rust-toolchain.toml
Normal file
4
risc0/ped_jubjub_test/rust-toolchain.toml
Normal file
@ -0,0 +1,4 @@
|
||||
[toolchain]
|
||||
channel = "stable"
|
||||
components = ["rustfmt", "rust-src"]
|
||||
profile = "minimal"
|
||||
11
risc0/ped_pallas_test/Cargo.toml
Normal file
11
risc0/ped_pallas_test/Cargo.toml
Normal file
@ -0,0 +1,11 @@
|
||||
[workspace]
|
||||
resolver = "2"
|
||||
members = ["host", "methods"]
|
||||
|
||||
# Always optimize; building and running the guest takes much longer without optimization.
|
||||
[profile.dev]
|
||||
opt-level = 3
|
||||
|
||||
[profile.release]
|
||||
debug = 1
|
||||
lto = true
|
||||
201
risc0/ped_pallas_test/LICENSE
Normal file
201
risc0/ped_pallas_test/LICENSE
Normal file
@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
111
risc0/ped_pallas_test/README.md
Normal file
111
risc0/ped_pallas_test/README.md
Normal file
@ -0,0 +1,111 @@
|
||||
# RISC Zero Rust Starter Template
|
||||
|
||||
Welcome to the RISC Zero Rust Starter Template! This template is intended to
|
||||
give you a starting point for building a project using the RISC Zero zkVM.
|
||||
Throughout the template (including in this README), you'll find comments
|
||||
labelled `TODO` in places where you'll need to make changes. To better
|
||||
understand the concepts behind this template, check out the [zkVM
|
||||
Overview][zkvm-overview].
|
||||
|
||||
## Quick Start
|
||||
|
||||
First, make sure [rustup] is installed. The
|
||||
[`rust-toolchain.toml`][rust-toolchain] file will be used by `cargo` to
|
||||
automatically install the correct version.
|
||||
|
||||
To build all methods and execute the method within the zkVM, run the following
|
||||
command:
|
||||
|
||||
```bash
|
||||
cargo run
|
||||
```
|
||||
|
||||
This is an empty template, and so there is no expected output (until you modify
|
||||
the code).
|
||||
|
||||
### Executing the Project Locally in Development Mode
|
||||
|
||||
During development, faster iteration upon code changes can be achieved by leveraging [dev-mode], we strongly suggest activating it during your early development phase. Furthermore, you might want to get insights into the execution statistics of your project, and this can be achieved by specifying the environment variable `RUST_LOG="[executor]=info"` before running your project.
|
||||
|
||||
Put together, the command to run your project in development mode while getting execution statistics is:
|
||||
|
||||
```bash
|
||||
RUST_LOG="[executor]=info" RISC0_DEV_MODE=1 cargo run
|
||||
```
|
||||
|
||||
### Running Proofs Remotely on Bonsai
|
||||
|
||||
_Note: The Bonsai proving service is still in early Alpha; an API key is
|
||||
required for access. [Click here to request access][bonsai access]._
|
||||
|
||||
If you have access to the URL and API key to Bonsai you can run your proofs
|
||||
remotely. To prove in Bonsai mode, invoke `cargo run` with two additional
|
||||
environment variables:
|
||||
|
||||
```bash
|
||||
BONSAI_API_KEY="YOUR_API_KEY" BONSAI_API_URL="BONSAI_URL" cargo run
|
||||
```
|
||||
|
||||
## How to Create a Project Based on This Template
|
||||
|
||||
Search this template for the string `TODO`, and make the necessary changes to
|
||||
implement the required feature described by the `TODO` comment. Some of these
|
||||
changes will be complex, and so we have a number of instructional resources to
|
||||
assist you in learning how to write your own code for the RISC Zero zkVM:
|
||||
|
||||
- The [RISC Zero Developer Docs][dev-docs] is a great place to get started.
|
||||
- Example projects are available in the [examples folder][examples] of
|
||||
[`risc0`][risc0-repo] repository.
|
||||
- Reference documentation is available at [https://docs.rs][docs.rs], including
|
||||
[`risc0-zkvm`][risc0-zkvm], [`cargo-risczero`][cargo-risczero],
|
||||
[`risc0-build`][risc0-build], and [others][crates].
|
||||
|
||||
## Directory Structure
|
||||
|
||||
It is possible to organize the files for these components in various ways.
|
||||
However, in this starter template we use a standard directory structure for zkVM
|
||||
applications, which we think is a good starting point for your applications.
|
||||
|
||||
```text
|
||||
project_name
|
||||
├── Cargo.toml
|
||||
├── host
|
||||
│ ├── Cargo.toml
|
||||
│ └── src
|
||||
│ └── main.rs <-- [Host code goes here]
|
||||
└── methods
|
||||
├── Cargo.toml
|
||||
├── build.rs
|
||||
├── guest
|
||||
│ ├── Cargo.toml
|
||||
│ └── src
|
||||
│ └── method_name.rs <-- [Guest code goes here]
|
||||
└── src
|
||||
└── lib.rs
|
||||
```
|
||||
|
||||
## Video Tutorial
|
||||
|
||||
For a walk-through of how to build with this template, check out this [excerpt
|
||||
from our workshop at ZK HACK III][zkhack-iii].
|
||||
|
||||
## Questions, Feedback, and Collaborations
|
||||
|
||||
We'd love to hear from you on [Discord][discord] or [Twitter][twitter].
|
||||
|
||||
[bonsai access]: https://bonsai.xyz/apply
|
||||
[cargo-risczero]: https://docs.rs/cargo-risczero
|
||||
[crates]: https://github.com/risc0/risc0/blob/main/README.md#rust-binaries
|
||||
[dev-docs]: https://dev.risczero.com
|
||||
[dev-mode]: https://dev.risczero.com/api/generating-proofs/dev-mode
|
||||
[discord]: https://discord.gg/risczero
|
||||
[docs.rs]: https://docs.rs/releases/search?query=risc0
|
||||
[examples]: https://github.com/risc0/risc0/tree/main/examples
|
||||
[risc0-build]: https://docs.rs/risc0-build
|
||||
[risc0-repo]: https://www.github.com/risc0/risc0
|
||||
[risc0-zkvm]: https://docs.rs/risc0-zkvm
|
||||
[rust-toolchain]: rust-toolchain.toml
|
||||
[rustup]: https://rustup.rs
|
||||
[twitter]: https://twitter.com/risczero
|
||||
[zkhack-iii]: https://www.youtube.com/watch?v=Yg_BGqj_6lg&list=PLcPzhUaCxlCgig7ofeARMPwQ8vbuD6hC5&index=5
|
||||
[zkvm-overview]: https://dev.risczero.com/zkvm
|
||||
10
risc0/ped_pallas_test/host/Cargo.toml
Normal file
10
risc0/ped_pallas_test/host/Cargo.toml
Normal file
@ -0,0 +1,10 @@
|
||||
[package]
|
||||
name = "host"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[dependencies]
|
||||
methods = { path = "../methods" }
|
||||
risc0-zkvm = { version = "^2.0.0" }
|
||||
tracing-subscriber = { version = "0.3", features = ["env-filter"] }
|
||||
serde = "1.0"
|
||||
50
risc0/ped_pallas_test/host/src/main.rs
Normal file
50
risc0/ped_pallas_test/host/src/main.rs
Normal file
@ -0,0 +1,50 @@
|
||||
// These constants represent the RISC-V ELF and the image ID generated by risc0-build.
|
||||
// The ELF is used for proving and the ID is used for verification.
|
||||
use methods::{PALLAS_PED_GUEST_ELF, PALLAS_PED_GUEST_ID};
|
||||
use risc0_zkvm::{default_prover, ExecutorEnv};
|
||||
|
||||
fn main() {
|
||||
// Initialize tracing. In order to view logs, run `RUST_LOG=info cargo run`
|
||||
tracing_subscriber::fmt()
|
||||
.with_env_filter(tracing_subscriber::filter::EnvFilter::from_default_env())
|
||||
.init();
|
||||
|
||||
// An executor environment describes the configurations for the zkVM
|
||||
// including program inputs.
|
||||
// A default ExecutorEnv can be created like so:
|
||||
// `let env = ExecutorEnv::builder().build().unwrap();`
|
||||
// However, this `env` does not have any inputs.
|
||||
//
|
||||
// To add guest input to the executor environment, use
|
||||
// ExecutorEnvBuilder::write().
|
||||
// To access this method, you'll need to use ExecutorEnv::builder(), which
|
||||
// creates an ExecutorEnvBuilder. When you're done adding input, call
|
||||
// ExecutorEnvBuilder::build().
|
||||
|
||||
// For example:
|
||||
let input: u32 = 15 * u32::pow(2, 27) + 1;
|
||||
let env = ExecutorEnv::builder()
|
||||
.write(&input)
|
||||
.unwrap()
|
||||
.build()
|
||||
.unwrap();
|
||||
|
||||
// Obtain the default prover.
|
||||
let prover = default_prover();
|
||||
|
||||
// Proof information by proving the specified ELF binary.
|
||||
// This struct contains the receipt along with statistics about execution of the guest
|
||||
let prove_info = prover.prove(env, PALLAS_PED_GUEST_ELF).unwrap();
|
||||
|
||||
// extract the receipt.
|
||||
let receipt = prove_info.receipt;
|
||||
|
||||
// TODO: Implement code for retrieving receipt journal here.
|
||||
|
||||
// For example:
|
||||
let _output: u32 = receipt.journal.decode().unwrap();
|
||||
|
||||
// The receipt was verified at the end of proving, but the below code is an
|
||||
// example of how someone else could verify this receipt.
|
||||
receipt.verify(PALLAS_PED_GUEST_ID).unwrap();
|
||||
}
|
||||
10
risc0/ped_pallas_test/methods/Cargo.toml
Normal file
10
risc0/ped_pallas_test/methods/Cargo.toml
Normal file
@ -0,0 +1,10 @@
|
||||
[package]
|
||||
name = "methods"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[build-dependencies]
|
||||
risc0-build = { version = "^2.0.1" }
|
||||
|
||||
[package.metadata.risc0]
|
||||
methods = ["guest"]
|
||||
3
risc0/ped_pallas_test/methods/build.rs
Normal file
3
risc0/ped_pallas_test/methods/build.rs
Normal file
@ -0,0 +1,3 @@
|
||||
fn main() {
|
||||
risc0_build::embed_methods();
|
||||
}
|
||||
10
risc0/ped_pallas_test/methods/guest/Cargo.toml
Normal file
10
risc0/ped_pallas_test/methods/guest/Cargo.toml
Normal file
@ -0,0 +1,10 @@
|
||||
[package]
|
||||
name = "pallas_ped_guest"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[workspace]
|
||||
|
||||
[dependencies]
|
||||
risc0-zkvm = { version = "^2.0.0", default-features = false, features = ['std'] }
|
||||
pasta_curves = "0.5.1"
|
||||
30
risc0/ped_pallas_test/methods/guest/src/main.rs
Normal file
30
risc0/ped_pallas_test/methods/guest/src/main.rs
Normal file
@ -0,0 +1,30 @@
|
||||
use risc0_zkvm::guest::env;
|
||||
|
||||
use pasta_curves::group::Group;
|
||||
|
||||
fn main() {
|
||||
// TODO: Implement your guest code here
|
||||
|
||||
// read the input
|
||||
let input: u32 = env::read();
|
||||
|
||||
// TODO: do something with the input
|
||||
|
||||
let g1 = pasta_curves::pallas::Point::generator();
|
||||
let g2 = g1 + g1;
|
||||
let g3 = g1 + g2;
|
||||
let g4 = g1 + g3;
|
||||
let g5 = g1 + g4;
|
||||
|
||||
let s1 = pasta_curves::pallas::Scalar::from(87329482u64);
|
||||
let s2 = pasta_curves::pallas::Scalar::from(37264829u64);
|
||||
let s3 = pasta_curves::pallas::Scalar::from(98098098u64);
|
||||
let s4 = pasta_curves::pallas::Scalar::from(63980948u64);
|
||||
let s5 = pasta_curves::pallas::Scalar::from(15098098u64);
|
||||
|
||||
let _ = g1*s1 + g2*s2 + g3*s3 + g4*s4 + g5*s5;
|
||||
|
||||
|
||||
// write public output to the journal
|
||||
env::commit(&input);
|
||||
}
|
||||
1
risc0/ped_pallas_test/methods/src/lib.rs
Normal file
1
risc0/ped_pallas_test/methods/src/lib.rs
Normal file
@ -0,0 +1 @@
|
||||
include!(concat!(env!("OUT_DIR"), "/methods.rs"));
|
||||
4
risc0/ped_pallas_test/rust-toolchain.toml
Normal file
4
risc0/ped_pallas_test/rust-toolchain.toml
Normal file
@ -0,0 +1,4 @@
|
||||
[toolchain]
|
||||
channel = "stable"
|
||||
components = ["rustfmt", "rust-src"]
|
||||
profile = "minimal"
|
||||
11
risc0/ped_secp256k1_test/Cargo.toml
Normal file
11
risc0/ped_secp256k1_test/Cargo.toml
Normal file
@ -0,0 +1,11 @@
|
||||
[workspace]
|
||||
resolver = "2"
|
||||
members = ["host", "methods"]
|
||||
|
||||
# Always optimize; building and running the guest takes much longer without optimization.
|
||||
[profile.dev]
|
||||
opt-level = 3
|
||||
|
||||
[profile.release]
|
||||
debug = 1
|
||||
lto = true
|
||||
201
risc0/ped_secp256k1_test/LICENSE
Normal file
201
risc0/ped_secp256k1_test/LICENSE
Normal file
@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
111
risc0/ped_secp256k1_test/README.md
Normal file
111
risc0/ped_secp256k1_test/README.md
Normal file
@ -0,0 +1,111 @@
|
||||
# RISC Zero Rust Starter Template
|
||||
|
||||
Welcome to the RISC Zero Rust Starter Template! This template is intended to
|
||||
give you a starting point for building a project using the RISC Zero zkVM.
|
||||
Throughout the template (including in this README), you'll find comments
|
||||
labelled `TODO` in places where you'll need to make changes. To better
|
||||
understand the concepts behind this template, check out the [zkVM
|
||||
Overview][zkvm-overview].
|
||||
|
||||
## Quick Start
|
||||
|
||||
First, make sure [rustup] is installed. The
|
||||
[`rust-toolchain.toml`][rust-toolchain] file will be used by `cargo` to
|
||||
automatically install the correct version.
|
||||
|
||||
To build all methods and execute the method within the zkVM, run the following
|
||||
command:
|
||||
|
||||
```bash
|
||||
cargo run
|
||||
```
|
||||
|
||||
This is an empty template, and so there is no expected output (until you modify
|
||||
the code).
|
||||
|
||||
### Executing the Project Locally in Development Mode
|
||||
|
||||
During development, faster iteration upon code changes can be achieved by leveraging [dev-mode], we strongly suggest activating it during your early development phase. Furthermore, you might want to get insights into the execution statistics of your project, and this can be achieved by specifying the environment variable `RUST_LOG="[executor]=info"` before running your project.
|
||||
|
||||
Put together, the command to run your project in development mode while getting execution statistics is:
|
||||
|
||||
```bash
|
||||
RUST_LOG="[executor]=info" RISC0_DEV_MODE=1 cargo run
|
||||
```
|
||||
|
||||
### Running Proofs Remotely on Bonsai
|
||||
|
||||
_Note: The Bonsai proving service is still in early Alpha; an API key is
|
||||
required for access. [Click here to request access][bonsai access]._
|
||||
|
||||
If you have access to the URL and API key to Bonsai you can run your proofs
|
||||
remotely. To prove in Bonsai mode, invoke `cargo run` with two additional
|
||||
environment variables:
|
||||
|
||||
```bash
|
||||
BONSAI_API_KEY="YOUR_API_KEY" BONSAI_API_URL="BONSAI_URL" cargo run
|
||||
```
|
||||
|
||||
## How to Create a Project Based on This Template
|
||||
|
||||
Search this template for the string `TODO`, and make the necessary changes to
|
||||
implement the required feature described by the `TODO` comment. Some of these
|
||||
changes will be complex, and so we have a number of instructional resources to
|
||||
assist you in learning how to write your own code for the RISC Zero zkVM:
|
||||
|
||||
- The [RISC Zero Developer Docs][dev-docs] is a great place to get started.
|
||||
- Example projects are available in the [examples folder][examples] of
|
||||
[`risc0`][risc0-repo] repository.
|
||||
- Reference documentation is available at [https://docs.rs][docs.rs], including
|
||||
[`risc0-zkvm`][risc0-zkvm], [`cargo-risczero`][cargo-risczero],
|
||||
[`risc0-build`][risc0-build], and [others][crates].
|
||||
|
||||
## Directory Structure
|
||||
|
||||
It is possible to organize the files for these components in various ways.
|
||||
However, in this starter template we use a standard directory structure for zkVM
|
||||
applications, which we think is a good starting point for your applications.
|
||||
|
||||
```text
|
||||
project_name
|
||||
├── Cargo.toml
|
||||
├── host
|
||||
│ ├── Cargo.toml
|
||||
│ └── src
|
||||
│ └── main.rs <-- [Host code goes here]
|
||||
└── methods
|
||||
├── Cargo.toml
|
||||
├── build.rs
|
||||
├── guest
|
||||
│ ├── Cargo.toml
|
||||
│ └── src
|
||||
│ └── method_name.rs <-- [Guest code goes here]
|
||||
└── src
|
||||
└── lib.rs
|
||||
```
|
||||
|
||||
## Video Tutorial
|
||||
|
||||
For a walk-through of how to build with this template, check out this [excerpt
|
||||
from our workshop at ZK HACK III][zkhack-iii].
|
||||
|
||||
## Questions, Feedback, and Collaborations
|
||||
|
||||
We'd love to hear from you on [Discord][discord] or [Twitter][twitter].
|
||||
|
||||
[bonsai access]: https://bonsai.xyz/apply
|
||||
[cargo-risczero]: https://docs.rs/cargo-risczero
|
||||
[crates]: https://github.com/risc0/risc0/blob/main/README.md#rust-binaries
|
||||
[dev-docs]: https://dev.risczero.com
|
||||
[dev-mode]: https://dev.risczero.com/api/generating-proofs/dev-mode
|
||||
[discord]: https://discord.gg/risczero
|
||||
[docs.rs]: https://docs.rs/releases/search?query=risc0
|
||||
[examples]: https://github.com/risc0/risc0/tree/main/examples
|
||||
[risc0-build]: https://docs.rs/risc0-build
|
||||
[risc0-repo]: https://www.github.com/risc0/risc0
|
||||
[risc0-zkvm]: https://docs.rs/risc0-zkvm
|
||||
[rust-toolchain]: rust-toolchain.toml
|
||||
[rustup]: https://rustup.rs
|
||||
[twitter]: https://twitter.com/risczero
|
||||
[zkhack-iii]: https://www.youtube.com/watch?v=Yg_BGqj_6lg&list=PLcPzhUaCxlCgig7ofeARMPwQ8vbuD6hC5&index=5
|
||||
[zkvm-overview]: https://dev.risczero.com/zkvm
|
||||
10
risc0/ped_secp256k1_test/host/Cargo.toml
Normal file
10
risc0/ped_secp256k1_test/host/Cargo.toml
Normal file
@ -0,0 +1,10 @@
|
||||
[package]
|
||||
name = "host"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[dependencies]
|
||||
methods = { path = "../methods" }
|
||||
risc0-zkvm = { version = "^2.1.0" }
|
||||
tracing-subscriber = { version = "0.3", features = ["env-filter"] }
|
||||
serde = "1.0"
|
||||
56
risc0/ped_secp256k1_test/host/src/main.rs
Normal file
56
risc0/ped_secp256k1_test/host/src/main.rs
Normal file
@ -0,0 +1,56 @@
|
||||
// These constants represent the RISC-V ELF and the image ID generated by risc0-build.
|
||||
// The ELF is used for proving and the ID is used for verification.
|
||||
use methods::{
|
||||
PED_SECP256K1_GUEST_ELF, PED_SECP256K1_GUEST_ID
|
||||
};
|
||||
use risc0_zkvm::{default_prover, ExecutorEnv};
|
||||
|
||||
fn main() {
|
||||
// Initialize tracing. In order to view logs, run `RUST_LOG=info cargo run`
|
||||
tracing_subscriber::fmt()
|
||||
.with_env_filter(tracing_subscriber::filter::EnvFilter::from_default_env())
|
||||
.init();
|
||||
|
||||
// An executor environment describes the configurations for the zkVM
|
||||
// including program inputs.
|
||||
// A default ExecutorEnv can be created like so:
|
||||
// `let env = ExecutorEnv::builder().build().unwrap();`
|
||||
// However, this `env` does not have any inputs.
|
||||
//
|
||||
// To add guest input to the executor environment, use
|
||||
// ExecutorEnvBuilder::write().
|
||||
// To access this method, you'll need to use ExecutorEnv::builder(), which
|
||||
// creates an ExecutorEnvBuilder. When you're done adding input, call
|
||||
// ExecutorEnvBuilder::build().
|
||||
|
||||
// For example:
|
||||
let input: u32 = 15 * u32::pow(2, 27) + 1;
|
||||
let env = ExecutorEnv::builder()
|
||||
.write(&input)
|
||||
.unwrap()
|
||||
.build()
|
||||
.unwrap();
|
||||
|
||||
// Obtain the default prover.
|
||||
let prover = default_prover();
|
||||
|
||||
// Proof information by proving the specified ELF binary.
|
||||
// This struct contains the receipt along with statistics about execution of the guest
|
||||
let prove_info = prover
|
||||
.prove(env, PED_SECP256K1_GUEST_ELF)
|
||||
.unwrap();
|
||||
|
||||
// extract the receipt.
|
||||
let receipt = prove_info.receipt;
|
||||
|
||||
// TODO: Implement code for retrieving receipt journal here.
|
||||
|
||||
// For example:
|
||||
let _output: u32 = receipt.journal.decode().unwrap();
|
||||
|
||||
// The receipt was verified at the end of proving, but the below code is an
|
||||
// example of how someone else could verify this receipt.
|
||||
receipt
|
||||
.verify(PED_SECP256K1_GUEST_ID)
|
||||
.unwrap();
|
||||
}
|
||||
10
risc0/ped_secp256k1_test/methods/Cargo.toml
Normal file
10
risc0/ped_secp256k1_test/methods/Cargo.toml
Normal file
@ -0,0 +1,10 @@
|
||||
[package]
|
||||
name = "methods"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[build-dependencies]
|
||||
risc0-build = { version = "^2.1.2" }
|
||||
|
||||
[package.metadata.risc0]
|
||||
methods = ["guest"]
|
||||
3
risc0/ped_secp256k1_test/methods/build.rs
Normal file
3
risc0/ped_secp256k1_test/methods/build.rs
Normal file
@ -0,0 +1,3 @@
|
||||
fn main() {
|
||||
risc0_build::embed_methods();
|
||||
}
|
||||
13
risc0/ped_secp256k1_test/methods/guest/Cargo.toml
Normal file
13
risc0/ped_secp256k1_test/methods/guest/Cargo.toml
Normal file
@ -0,0 +1,13 @@
|
||||
[package]
|
||||
name = "ped_secp256k1_guest"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[workspace]
|
||||
|
||||
[dependencies]
|
||||
risc0-zkvm = { version = "^2.1.0", default-features = false, features = ['std', 'unstable'] }
|
||||
k256 = "0.13.3"
|
||||
|
||||
[patch.crates-io]
|
||||
k256 = { git = "https://github.com/risc0/RustCrypto-elliptic-curves", tag = "k256/v0.13.3-risczero.1" }
|
||||
26
risc0/ped_secp256k1_test/methods/guest/src/main.rs
Normal file
26
risc0/ped_secp256k1_test/methods/guest/src/main.rs
Normal file
@ -0,0 +1,26 @@
|
||||
use risc0_zkvm::guest::env;
|
||||
|
||||
fn main() {
|
||||
// TODO: Implement your guest code here
|
||||
|
||||
// read the input
|
||||
let input: u32 = env::read();
|
||||
|
||||
// TODO: do something with the input
|
||||
let g1 = k256::ProjectivePoint::GENERATOR;
|
||||
let g2 = g1 + g1;
|
||||
let g3 = g1 + g2;
|
||||
let g4 = g1 + g3;
|
||||
let g5 = g1 + g4;
|
||||
|
||||
|
||||
let s1 = k256::Scalar::from(87329482u64);
|
||||
let s2 = k256::Scalar::from(37264829u64);
|
||||
let s3 = k256::Scalar::from(98098098u64);
|
||||
let s4 = k256::Scalar::from(63980948u64);
|
||||
let s5 = k256::Scalar::from(15098098u64);
|
||||
|
||||
let _ = g1*s1 + g2*s2 + g3*s3 + g4*s4 + g5*s5;
|
||||
// write public output to the journal
|
||||
env::commit(&input);
|
||||
}
|
||||
1
risc0/ped_secp256k1_test/methods/src/lib.rs
Normal file
1
risc0/ped_secp256k1_test/methods/src/lib.rs
Normal file
@ -0,0 +1 @@
|
||||
include!(concat!(env!("OUT_DIR"), "/methods.rs"));
|
||||
4
risc0/ped_secp256k1_test/rust-toolchain.toml
Normal file
4
risc0/ped_secp256k1_test/rust-toolchain.toml
Normal file
@ -0,0 +1,4 @@
|
||||
[toolchain]
|
||||
channel = "stable"
|
||||
components = ["rustfmt", "rust-src"]
|
||||
profile = "minimal"
|
||||
11
risc0/ped_vesta_test/Cargo.toml
Normal file
11
risc0/ped_vesta_test/Cargo.toml
Normal file
@ -0,0 +1,11 @@
|
||||
[workspace]
|
||||
resolver = "2"
|
||||
members = ["host", "methods"]
|
||||
|
||||
# Always optimize; building and running the guest takes much longer without optimization.
|
||||
[profile.dev]
|
||||
opt-level = 3
|
||||
|
||||
[profile.release]
|
||||
debug = 1
|
||||
lto = true
|
||||
201
risc0/ped_vesta_test/LICENSE
Normal file
201
risc0/ped_vesta_test/LICENSE
Normal file
@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
111
risc0/ped_vesta_test/README.md
Normal file
111
risc0/ped_vesta_test/README.md
Normal file
@ -0,0 +1,111 @@
|
||||
# RISC Zero Rust Starter Template
|
||||
|
||||
Welcome to the RISC Zero Rust Starter Template! This template is intended to
|
||||
give you a starting point for building a project using the RISC Zero zkVM.
|
||||
Throughout the template (including in this README), you'll find comments
|
||||
labelled `TODO` in places where you'll need to make changes. To better
|
||||
understand the concepts behind this template, check out the [zkVM
|
||||
Overview][zkvm-overview].
|
||||
|
||||
## Quick Start
|
||||
|
||||
First, make sure [rustup] is installed. The
|
||||
[`rust-toolchain.toml`][rust-toolchain] file will be used by `cargo` to
|
||||
automatically install the correct version.
|
||||
|
||||
To build all methods and execute the method within the zkVM, run the following
|
||||
command:
|
||||
|
||||
```bash
|
||||
cargo run
|
||||
```
|
||||
|
||||
This is an empty template, and so there is no expected output (until you modify
|
||||
the code).
|
||||
|
||||
### Executing the Project Locally in Development Mode
|
||||
|
||||
During development, faster iteration upon code changes can be achieved by leveraging [dev-mode], we strongly suggest activating it during your early development phase. Furthermore, you might want to get insights into the execution statistics of your project, and this can be achieved by specifying the environment variable `RUST_LOG="[executor]=info"` before running your project.
|
||||
|
||||
Put together, the command to run your project in development mode while getting execution statistics is:
|
||||
|
||||
```bash
|
||||
RUST_LOG="[executor]=info" RISC0_DEV_MODE=1 cargo run
|
||||
```
|
||||
|
||||
### Running Proofs Remotely on Bonsai
|
||||
|
||||
_Note: The Bonsai proving service is still in early Alpha; an API key is
|
||||
required for access. [Click here to request access][bonsai access]._
|
||||
|
||||
If you have access to the URL and API key to Bonsai you can run your proofs
|
||||
remotely. To prove in Bonsai mode, invoke `cargo run` with two additional
|
||||
environment variables:
|
||||
|
||||
```bash
|
||||
BONSAI_API_KEY="YOUR_API_KEY" BONSAI_API_URL="BONSAI_URL" cargo run
|
||||
```
|
||||
|
||||
## How to Create a Project Based on This Template
|
||||
|
||||
Search this template for the string `TODO`, and make the necessary changes to
|
||||
implement the required feature described by the `TODO` comment. Some of these
|
||||
changes will be complex, and so we have a number of instructional resources to
|
||||
assist you in learning how to write your own code for the RISC Zero zkVM:
|
||||
|
||||
- The [RISC Zero Developer Docs][dev-docs] is a great place to get started.
|
||||
- Example projects are available in the [examples folder][examples] of
|
||||
[`risc0`][risc0-repo] repository.
|
||||
- Reference documentation is available at [https://docs.rs][docs.rs], including
|
||||
[`risc0-zkvm`][risc0-zkvm], [`cargo-risczero`][cargo-risczero],
|
||||
[`risc0-build`][risc0-build], and [others][crates].
|
||||
|
||||
## Directory Structure
|
||||
|
||||
It is possible to organize the files for these components in various ways.
|
||||
However, in this starter template we use a standard directory structure for zkVM
|
||||
applications, which we think is a good starting point for your applications.
|
||||
|
||||
```text
|
||||
project_name
|
||||
├── Cargo.toml
|
||||
├── host
|
||||
│ ├── Cargo.toml
|
||||
│ └── src
|
||||
│ └── main.rs <-- [Host code goes here]
|
||||
└── methods
|
||||
├── Cargo.toml
|
||||
├── build.rs
|
||||
├── guest
|
||||
│ ├── Cargo.toml
|
||||
│ └── src
|
||||
│ └── method_name.rs <-- [Guest code goes here]
|
||||
└── src
|
||||
└── lib.rs
|
||||
```
|
||||
|
||||
## Video Tutorial
|
||||
|
||||
For a walk-through of how to build with this template, check out this [excerpt
|
||||
from our workshop at ZK HACK III][zkhack-iii].
|
||||
|
||||
## Questions, Feedback, and Collaborations
|
||||
|
||||
We'd love to hear from you on [Discord][discord] or [Twitter][twitter].
|
||||
|
||||
[bonsai access]: https://bonsai.xyz/apply
|
||||
[cargo-risczero]: https://docs.rs/cargo-risczero
|
||||
[crates]: https://github.com/risc0/risc0/blob/main/README.md#rust-binaries
|
||||
[dev-docs]: https://dev.risczero.com
|
||||
[dev-mode]: https://dev.risczero.com/api/generating-proofs/dev-mode
|
||||
[discord]: https://discord.gg/risczero
|
||||
[docs.rs]: https://docs.rs/releases/search?query=risc0
|
||||
[examples]: https://github.com/risc0/risc0/tree/main/examples
|
||||
[risc0-build]: https://docs.rs/risc0-build
|
||||
[risc0-repo]: https://www.github.com/risc0/risc0
|
||||
[risc0-zkvm]: https://docs.rs/risc0-zkvm
|
||||
[rust-toolchain]: rust-toolchain.toml
|
||||
[rustup]: https://rustup.rs
|
||||
[twitter]: https://twitter.com/risczero
|
||||
[zkhack-iii]: https://www.youtube.com/watch?v=Yg_BGqj_6lg&list=PLcPzhUaCxlCgig7ofeARMPwQ8vbuD6hC5&index=5
|
||||
[zkvm-overview]: https://dev.risczero.com/zkvm
|
||||
10
risc0/ped_vesta_test/host/Cargo.toml
Normal file
10
risc0/ped_vesta_test/host/Cargo.toml
Normal file
@ -0,0 +1,10 @@
|
||||
[package]
|
||||
name = "host"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[dependencies]
|
||||
methods = { path = "../methods" }
|
||||
risc0-zkvm = { version = "^2.1.0" }
|
||||
tracing-subscriber = { version = "0.3", features = ["env-filter"] }
|
||||
serde = "1.0"
|
||||
56
risc0/ped_vesta_test/host/src/main.rs
Normal file
56
risc0/ped_vesta_test/host/src/main.rs
Normal file
@ -0,0 +1,56 @@
|
||||
// These constants represent the RISC-V ELF and the image ID generated by risc0-build.
|
||||
// The ELF is used for proving and the ID is used for verification.
|
||||
use methods::{
|
||||
VESTA_PED_GUEST_ELF, VESTA_PED_GUEST_ID
|
||||
};
|
||||
use risc0_zkvm::{default_prover, ExecutorEnv};
|
||||
|
||||
fn main() {
|
||||
// Initialize tracing. In order to view logs, run `RUST_LOG=info cargo run`
|
||||
tracing_subscriber::fmt()
|
||||
.with_env_filter(tracing_subscriber::filter::EnvFilter::from_default_env())
|
||||
.init();
|
||||
|
||||
// An executor environment describes the configurations for the zkVM
|
||||
// including program inputs.
|
||||
// A default ExecutorEnv can be created like so:
|
||||
// `let env = ExecutorEnv::builder().build().unwrap();`
|
||||
// However, this `env` does not have any inputs.
|
||||
//
|
||||
// To add guest input to the executor environment, use
|
||||
// ExecutorEnvBuilder::write().
|
||||
// To access this method, you'll need to use ExecutorEnv::builder(), which
|
||||
// creates an ExecutorEnvBuilder. When you're done adding input, call
|
||||
// ExecutorEnvBuilder::build().
|
||||
|
||||
// For example:
|
||||
let input: u32 = 15 * u32::pow(2, 27) + 1;
|
||||
let env = ExecutorEnv::builder()
|
||||
.write(&input)
|
||||
.unwrap()
|
||||
.build()
|
||||
.unwrap();
|
||||
|
||||
// Obtain the default prover.
|
||||
let prover = default_prover();
|
||||
|
||||
// Proof information by proving the specified ELF binary.
|
||||
// This struct contains the receipt along with statistics about execution of the guest
|
||||
let prove_info = prover
|
||||
.prove(env, VESTA_PED_GUEST_ELF)
|
||||
.unwrap();
|
||||
|
||||
// extract the receipt.
|
||||
let receipt = prove_info.receipt;
|
||||
|
||||
// TODO: Implement code for retrieving receipt journal here.
|
||||
|
||||
// For example:
|
||||
let _output: u32 = receipt.journal.decode().unwrap();
|
||||
|
||||
// The receipt was verified at the end of proving, but the below code is an
|
||||
// example of how someone else could verify this receipt.
|
||||
receipt
|
||||
.verify(VESTA_PED_GUEST_ID)
|
||||
.unwrap();
|
||||
}
|
||||
10
risc0/ped_vesta_test/methods/Cargo.toml
Normal file
10
risc0/ped_vesta_test/methods/Cargo.toml
Normal file
@ -0,0 +1,10 @@
|
||||
[package]
|
||||
name = "methods"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[build-dependencies]
|
||||
risc0-build = { version = "^2.1.2" }
|
||||
|
||||
[package.metadata.risc0]
|
||||
methods = ["guest"]
|
||||
3
risc0/ped_vesta_test/methods/build.rs
Normal file
3
risc0/ped_vesta_test/methods/build.rs
Normal file
@ -0,0 +1,3 @@
|
||||
fn main() {
|
||||
risc0_build::embed_methods();
|
||||
}
|
||||
10
risc0/ped_vesta_test/methods/guest/Cargo.toml
Normal file
10
risc0/ped_vesta_test/methods/guest/Cargo.toml
Normal file
@ -0,0 +1,10 @@
|
||||
[package]
|
||||
name = "vesta_ped_guest"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[workspace]
|
||||
|
||||
[dependencies]
|
||||
risc0-zkvm = { version = "^2.1.0", default-features = false, features = ['std'] }
|
||||
pasta_curves = "0.5.1"
|
||||
26
risc0/ped_vesta_test/methods/guest/src/main.rs
Normal file
26
risc0/ped_vesta_test/methods/guest/src/main.rs
Normal file
@ -0,0 +1,26 @@
|
||||
use risc0_zkvm::guest::env;
|
||||
use pasta_curves::group::Group;
|
||||
|
||||
fn main() {
|
||||
// TODO: Implement your guest code here
|
||||
|
||||
// read the input
|
||||
let input: u32 = env::read();
|
||||
|
||||
let g1 = pasta_curves::vesta::Point::generator();
|
||||
let g2 = g1 + g1;
|
||||
let g3 = g1 + g2;
|
||||
let g4 = g1 + g3;
|
||||
let g5 = g1 + g4;
|
||||
|
||||
let s1 = pasta_curves::vesta::Scalar::from(87329482u64);
|
||||
let s2 = pasta_curves::vesta::Scalar::from(37264829u64);
|
||||
let s3 = pasta_curves::vesta::Scalar::from(98098098u64);
|
||||
let s4 = pasta_curves::vesta::Scalar::from(63980948u64);
|
||||
let s5 = pasta_curves::vesta::Scalar::from(15098098u64);
|
||||
|
||||
let _ = g1*s1 + g2*s2 + g3*s3 + g4*s4 + g5*s5;
|
||||
|
||||
// write public output to the journal
|
||||
env::commit(&input);
|
||||
}
|
||||
1
risc0/ped_vesta_test/methods/src/lib.rs
Normal file
1
risc0/ped_vesta_test/methods/src/lib.rs
Normal file
@ -0,0 +1 @@
|
||||
include!(concat!(env!("OUT_DIR"), "/methods.rs"));
|
||||
4
risc0/ped_vesta_test/rust-toolchain.toml
Normal file
4
risc0/ped_vesta_test/rust-toolchain.toml
Normal file
@ -0,0 +1,4 @@
|
||||
[toolchain]
|
||||
channel = "stable"
|
||||
components = ["rustfmt", "rust-src"]
|
||||
profile = "minimal"
|
||||
Loading…
x
Reference in New Issue
Block a user