docs(core,ark-zkey): Instructions for how to generate arkzkey

zkmopro · Nov 11, 2023 · 67423cf · 67423cf
1 parent 0c110e2
commit 67423cf
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/ark-zkey/README.md b/ark-zkey/README.md
@@ -4,6 +4,20 @@ Library to read `zkey` faster by serializing to `arkworks` friendly format.
 
 See https://github.com/oskarth/mopro/issues/25 for context.
 
+## To generate arkzkey
+
+Hacky, but the way we generate `arkzkey` now is by running the corresponding test.
+
+E.g.:
+
+```
+cargo test multiplier2 --release -- --nocapture
+cargo test keccak256 --release -- --nocapture
+cargo test rsa --release -- --nocapture
+```
+
+Will take corresponding `zkey` and put `arkzkey`` in same folder.
+
 ## Multiplier
 
 NOTE: Need to change const ZKEY here

diff --git a/mopro-core/README.md b/mopro-core/README.md
@@ -33,3 +33,7 @@ Note that:
 - It has to be built for the right architecture
 - Have to run `install_name_tool` to adjust install name
 - Run `codesign` to sign dylib for use on iOS
+
+## To use ark-zkey
+
+Experimental support for significantly faster zkey loading. See `../ark-zkey` README for how to build arkzkey.