The current dev version of this repo is using some more update Hardcaml packages which as of early 2023 need to be pinned. See `.github/workflow/main.yml for details.
The branch
zprize-2022-submissionis a version of the repo which should work with the Hardcaml packages released on opam.
In 2022, we, the team who develops Hardcaml (Andy Ray, Ben Devlin, Fu Yong Quah, and Rahul Yesantharao) participated in the ZPrize competition. We competed in the Multi-Scalar Multiplication (MSM) and Number Theoretic Transform (NTT) tracks.
See https://zprize.hardcaml.com for a detailed write up on our design, results and build instructions!
This repo has submissions to two of the ZPrize tracks, in the zprize folder.
The RTL (Verilog) used by various flows in this repo is written using the Hardcaml library, which needs OCaml installed to generate.
- Follow the instructions in https://opam.ocaml.org/doc/Install.html to install opam, the OCaml package manager
- Install the OCaml 4.13.1 compiler. You might need to run
opam switch create 4.13.1
eval $(opam env) # to pick up relevant environment variables
- Install the relevant OCaml dependencies
opam install . --deps-only
You might need to install extra packages (m4 gmp-devep libffi-devel
libgmp3-dev), especially on the AWS boxes. In ubuntu you can run the following
command. For Centos on the AWS boxes, use sudo yum install.
sudo apt-get install m4 gmp-devel libffi-devel libgmp3-dev z3 cargo
To check everything installed correctly
opam exec -- dune build
opam exec -- dune runtest
Now please continue to the relevant to build the top level designs from source.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as below, without any additional terms or conditions.
Copyright 2022 Andy Ray, Ben Devlin, Fu Yong Quah, Rahul Yesantharao.
This project is licensed under either of
at your option.
The SPDX license identifier for this project is MIT OR Apache-2.0.