Hash benchmark

.gitignore

@@ -2,3 +2,4 @@
 build
 target
 a.out
+Cargo.lock

.gitmodules

@@ -13,3 +13,6 @@
 [submodule "hash/snark/src/hash-circuits"]
 	path = hash/snark/external/hash-circuits
 	url = https://github.com/faulhornlabs/hash-circuits
+[submodule "hash/risc0/external/risc0"]
+	path = hash/risc0/external/risc0
+	url = https://github.com/risc0/risc0.git

hash/risc0/bench/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "rust-analyzer.linkedProjects": [
+        "./methods/guest/Cargo.toml"
+    ]
+}

hash/risc0/bench/Cargo.toml

@@ -0,0 +1,24 @@
+[package]
+name = "benchmark"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+risc0-zkvm = { path = "../external/risc0/risc0/zkvm", default-features = false, features = ["prove",] }
+serde = "1.0"
+rand = "0.8.3"
+sha2 ={ git = "https://github.com/risc0/RustCrypto-hashes", tag = "sha2-v0.10.6-risczero.0" }
+benchmark_methods = { path = "methods" }
+zkhash = { git = "https://github.com/HorizenLabs/poseidon2.git"}
+ark-ff = "0.4.2"
+hex = "0.4.3"
+ark-serialize = "0.4"
+risc0-core = { path = "../external/risc0/risc0/core" }
+tracing-subscriber = { version = "0.3", features = ["env-filter"] }
+
+[profile.dev]
+opt-level = 3
+
+[profile.release]
+debug = 1
+lto = true

hash/risc0/bench/LICENSE

@@ -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.

hash/risc0/bench/README.md

@@ -0,0 +1,12 @@
+Benchmarking different hashes inside risc'0 zkvm
+-----------------------------------------------
+
+The benchmark is defined by the following shell scripts:
+
+- `build.sh` - build the code.
+
+- `run.sh` and `run2.sh` - run the benchmark itself (`run.sh` for sha256, keccak, blake2b, blake3 and `run2.sh` for poseidon2 over bn128 and babybear)
+
+Benchmarks can be parameterized using environment variables. By convention, we start the names of these environment variables with the `ZKBENCH_` prefix.
+
+Additional files `bench.cfg` and `bench_tree.cfg` specifies the configurations and parameters.

hash/risc0/bench/bench.cfg

@@ -0,0 +1,11 @@
+name:   "Hashes benchmarking using risc0 prover"
+author: 
+timeout: 200
+params:
+  [ HASH_TYPE:     [ "sha256", "keccak", "blake2b", "blake3"]
+  , INPUT_SIZE_BYTES: [ 256, 512, 1024, 2048 ]
+  ]
+tags: risc0, $HASH_TYPE
+comments:
+  The benchmarks includes for sha256, keccak, blake2b, blake3.
+  the hashing is done inside the guest and receipt is received which is verified. 

hash/risc0/bench/bench_tree.cfg

@@ -0,0 +1,11 @@
+name:   "Hashes benchmarking using risc0 prover"
+author: 
+timeout: 1000
+params:
+  [ HASH_TYPE_TREE:     [ "poseidon2_babybear", "poseidon2_babybear_native", "poseidon2_bn128"]
+  , TREE_DEPTH: [ 2, 4, 8, 16 ]
+  ]
+tags: risc0, $HASH_TYPE_TREE
+comments:
+  The benchmarks includes for poseidon2(merkle hashing) over bn128 and babybear.
+  the hashing is done inside the guest and receipt is received which is verified. 

hash/risc0/bench/build.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+ cargo build --release

hash/risc0/bench/methods/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "benchmark_methods"
+version = "0.1.0"
+edition = "2021"
+
+[build-dependencies]
+risc0-build = { path = "../../external/risc0/risc0/build" }
+
+[package.metadata.risc0]
+methods = ["guest"]

hash/risc0/bench/methods/build.rs

@@ -0,0 +1,3 @@
+fn main() {
+    risc0_build::embed_methods();
+}

hash/risc0/bench/methods/guest/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+name = "method"
+version = "0.1.0"
+edition = "2021"
+
+[workspace]
+
+[dependencies]
+# If you want to try (experimental) std support, add `features = [ "std" ]` to risc0-zkvm
+risc0-zkvm = { path = "../../../external/risc0/risc0/zkvm", default-features = false,features = ["std"] }
+sha3 = { git = "https://github.com/risc0/RustCrypto-hashes", tag = "sha2-v0.10.6-risczero.0", default-features = false }
+sha2 ={ git = "https://github.com/risc0/RustCrypto-hashes", tag = "sha2-v0.10.6-risczero.0" }
+risc0-zkp = {path = "../../../external/risc0/risc0/zkp", default-features = false}
+blake3 = "1.5.0"
+zkhash = { git = "https://github.com/HorizenLabs/poseidon2.git"}
+ark-serialize = "0.4"
+ark-ff = "0.4.2"
+risc0-core = {path = "../../../external/risc0/risc0/core"}
+lazy_static = "1.4"
+# risc0-zkp-core = "0.10.0"
+rand = "0.8.5"

hash/risc0/bench/methods/guest/src/bin/blake2b.rs

@@ -0,0 +1,18 @@
+#![no_main]
+
+use risc0_zkvm::{guest::env, sha::Digest};
+use risc0_zkp::core::hash::blake2b::{Blake2b, Blake2bCpuImpl};
+use std::io::Read;
+
+risc0_zkvm::guest::entry!(main);
+
+pub fn main() {
+
+    let mut data = Vec::<u8>::new();
+    env::stdin().read_to_end(&mut data).unwrap();
+
+    let hash = Blake2bCpuImpl::blake2b(&data);
+    let digest: Digest = hash.into();
+    env::commit(&digest)
+
+}

hash/risc0/bench/methods/guest/src/bin/blake3.rs

@@ -0,0 +1,18 @@
+#![no_main]
+
+use risc0_zkvm::{guest::env, sha::Digest};
+use blake3::hash;
+use std::io::Read;
+
+risc0_zkvm::guest::entry!(main);
+
+pub fn main() {
+
+    let mut data = Vec::<u8>::new();
+    env::stdin().read_to_end(&mut data).unwrap();
+
+    let result = hash(&data);
+    let digest = Digest::try_from(*result.as_bytes()).unwrap();
+    env::commit(&digest)
+
+}

hash/risc0/bench/methods/guest/src/bin/keccak.rs

@@ -0,0 +1,18 @@
+#![no_main]
+
+use risc0_zkvm::{guest::env, sha::Digest};
+use sha3::{Digest as _, Keccak256};
+use std::io::Read;
+
+risc0_zkvm::guest::entry!(main);
+
+pub fn main() {
+
+    let mut data = Vec::<u8>::new();
+    env::stdin().read_to_end(&mut data).unwrap();
+
+    let hash: [u8;32] = Keccak256::digest(data).into();
+    let digest  = Digest::try_from(hash).unwrap();
+    env::commit(&digest)
+
+}