-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added documentation for compute_shuffled_index.
Added correct json input for compute_shuffled_index circuit in example. Clone test input data if needed.
- Loading branch information
1 parent
ce0579f
commit fb86c0a
Showing
2 changed files
with
22 additions
and
0 deletions.
There are no files selected for viewing
17 changes: 17 additions & 0 deletions
17
vendor/zkllvm-metacraft-circuits/docs/compute_shuffled_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Compute shuffled index documentation. | ||
|
||
### *Implementation* | ||
The implementation code of the circuit is under "DendrETH/vendor/zkllvm-metacraft-circuits/src/circuits_impl/". | ||
This code is used in both the compilation as circuit and as executable. | ||
|
||
### *Circuit build* | ||
In order to build as circuit, we need an entry point marked with the `[[circuit]]` directive. This is done through a wrapper | ||
that uses the implementation code and resides in "DendrETH/vendor/zkllvm-metacraft-circuits/src/circuits". Since currently the Crypto3 | ||
library does not implement computation of sha256 on a byte buffer, we use a header only library for the sha256 computations, which has | ||
negative performance consequences. | ||
|
||
### *Executable build + tests* | ||
The implementation code of the circuit is compiled as executable and tested against the input data from | ||
https://github.com/ethereum/consensus-spec-tests.git. The tests reside in "DendrETH/vendor/zkllvm-metacraft-circuits/src/tests/compute_shuffled_index_test/". | ||
For convenience, we have a script that performs all necessary steps to run the test -> "DendrETH/vendor/zkllvm-metacraft-circuits/scripts/compile_and_run_tests.sh". | ||
It is required that docker is installed on the machine that will run the tests. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters