Release 0.4.0

.travis.yml

@@ -1,5 +1,5 @@
 os: linux
-dist: bionic
+dist: focal
 language: generic
 addons:
   apt:
@@ -10,13 +10,21 @@ services:
 
 env:
   global:
-    - CONTAINER_JAVA_VER="openjdk-8-jdk=8u252-b09-1~16.04"
-    - CONTAINER_RUST_VER="1.41.0"
+    - CONTAINER_JAVA_VER="openjdk-8-jdk"
+jobs:
+    #- name: rust_1.51
+    #  env: CONTAINER_RUST_VER='1.51.0'
+    #- name: rust_1.51_asm
+    #  env: CONTAINER_RUST_VER='1.51.0' RUSTFLAGS='--emit=asm'
+    - name: rust_1.51_asm_target-feature
+      env: CONTAINER_RUST_VER='1.51.0' RUSTFLAGS='-C target-feature=+bmi2,+adx --emit=asm'
+    #- name: rust_nightly
+    #  env: CONTAINER_RUST_VER='nightly-2021-04-25' RUSTFLAGS='-C target-feature=+bmi2,+adx --emit=asm'
 
 script: >-
   source ci/setup_env.sh &&
   docker build --pull --no-cache -t zencash/zendoo-sc-cryptolib-builder ./ci &&
   bash -c "docker run --rm -v $(pwd):/build -v ${HOME}/key.asc:/key.asc --tmpfs /tmp:uid=$(id -u),gid=$(id -g),exec,mode=1777 \
-    --tmpfs /run:uid=$(id -u),gid=$(id -g),exec,mode=1777 -e LOCAL_USER_ID=$(id -u) -e LOCAL_GRP_ID=$(id -g) \
+    --tmpfs /run:uid=$(id -u),gid=$(id -g),exec,mode=1777 -e RUSTFLAGS -e LOCAL_USER_ID=$(id -u) -e LOCAL_GRP_ID=$(id -g) -e CARGO_AUDIT_EXIT_ON_ERROR \
     $(env | grep -E '^CONTAINER_' | sed -n '/^[^\t]/s/=.*//p' | sed '/^$/d' | sed 's/^/-e /g' | tr '\n' ' ') \
     zencash/zendoo-sc-cryptolib-builder /build/ci/start_ci.sh"

AUTHORS

@@ -0,0 +1,6 @@
+Daniele Di Benedetto <daniele@horizenlabs.io>
+Oleksandr Iozhytsia <oleksandr@zensystem.io>
+Volodymyr Babaiev <volodymyr.babaiev@infopulse.com>
+Maksym Vereshchak <phoinic@gmail.com>
+Luigi Varriale <luigi@horizenlabs.io>
+cronicc <cronic@horizenlabs.io>

BUILD.md

@@ -0,0 +1,42 @@
+# Build guide
+
+The library compiles on the `1.51.0 stable` toolchain of the Rust compiler. To install Rust, first install `rustup` by following the instructions [here](https://rustup.rs/), or via your platform's package manager. Once `rustup` is installed, install the appropriate Rust toolchain by invoking:
+```bash
+rustup install 1.51.0
+```
+After that, use `cargo`, the standard Rust build tool, to build the library:
+```bash
+git clone https://github.com/HorizenOfficial/ginger-lib.git
+cd ginger-lib
+cargo build --release
+```
+This library comes with unit tests for each of the provided crates. Run the tests with:
+```bash
+cargo test --all-features 
+```
+Compiling with `adcxq`, `adoxq` and `mulxq` instructions can lead to a 30-70% speedup. These are available on most `x86_64` platforms (Broadwell onwards for Intel and Ryzen onwards for AMD). Run the following command:
+```bash
+RUSTFLAGS="-C target-feature=+bmi2,+adx" cargo test/build/bench --features asm
+```
+Tip: If optimising for performance, your mileage may vary with passing `--emit=asm` to `RUSTFLAGS`.
+
+## Java Jar build guide
+
+To be able to build a Java Jar package you can use the `build_jar.sh` script in `ci` folder.
+Requirements:
+1. Build on Linux (Ubuntu 18.04+, for example) with a cross compilation of a native Rust code for windows target as well.
+2. Add windows target support for `cargo`:
+    ```
+    rustup target add x86_64-pc-windows-gnu
+    rustup toolchain install stable-x86_64-pc-windows-gnu
+    ```
+3. Install maven, openjdk, clang, llvm, mingw:
+    ```
+    sudo apt-get install clang llvm maven gcc-mingw-w64-x86-64 g++-mingw-w64-x86-64
+    ```
+4. Configure `mingw` to be able to cross compile the windows target of cryptolib dependencies:
+    ```
+    update-alternatives --install /usr/bin/x86_64-w64-mingw32-gcc x86_64-w64-mingw32-gcc /usr/bin/x86_64-w64-mingw32-gcc-posix 100
+    update-alternatives --install /usr/bin/x86_64-w64-mingw32-g++ x86_64-w64-mingw32-g++ /usr/bin/x86_64-w64-mingw32-g++-posix 100
+    ``` 
+5. Run `./ci/build_jar.sh`

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+## Contributing
+
+Contributions are welcomed! Bug fixes and new features can be initiated through GitHub pull requests. To speed the code review process, please adhere to the following guidelines:
+
+* Follow Horizen repositories' *code of conduct*
+* Follow Horizen repositories' *styling guide* 
+* Please gpg sign your commits 
+* Please make sure you push your pull requests to the development branch

Cargo.toml

@@ -1,6 +1,10 @@
 [workspace]
 
-members = ["demo-circuit", "ouroboros", "api"]
+members = [
+    "demo-circuit",
+    #"ouroboros",
+    "api"
+]
 
 [profile.release]
 opt-level = 3
@@ -16,6 +20,22 @@ panic = "unwind"
 opt-level = 3
 lto = "thin"
 incremental = true
-debug-assertions = true
-debug = true
-panic = "unwind"
+panic = "unwind"
+
+# Uncomment these lines for local development paths
+#
+#[patch.'https://github.com/HorizenOfficial/ginger-lib.git']
+#algebra = { path = '../ginger-lib/algebra' }
+#primitives = { path = '../ginger-lib/primitives' }
+#r1cs-core = { path = '../ginger-lib/r1cs/core' }
+#r1cs-crypto = { path = '../ginger-lib/r1cs/gadgets/crypto' }
+#r1cs-std = { path = '../ginger-lib/r1cs/gadgets/std' }
+#
+#[patch.'https://github.com/HorizenOfficial/zendoo-cctp-lib.git']
+#cctp_primitives = { path = '../zendoo-cctp-lib/cctp_primitives' }
+#
+#[patch.'https://github.com/HorizenLabs/marlin']
+#marlin = { path = '../marlin' }
+#
+#[patch.'https://github.com/HorizenLabs/poly-commit']
+#poly-commit = { path = '../poly-commit' }

LICENSE-MIT

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,57 +1,52 @@
-
-# zendoo-sc-cryptolib
+<h1 align="center">zendoo-sc-cryptolib</h1>
+<p align="center">
+    <a href= "https://github.com/HorizenOfficial/zendoo-sc-cryptolib/releases"><img src="https://img.shields.io/github/release/HorizenOfficial/zendoo-sc-cryptolib.svg"></a>
+    <a href="AUTHORS"><img src="https://img.shields.io/github/contributors/HorizenOfficial/zendoo-sc-cryptolib.svg?"></a>
+    <a href="https://travis-ci.com/github/HorizenOfficial/zendoo-sc-cryptolib"><img src="https://app.travis-ci.com/HorizenOfficial/zendoo-sc-cryptolib.svg?branch=master"></a>
+    <a href="LICENSE-MIT"><img src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
+    <a href="CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square"></a>
+</p>
 
 `zendoo-sc-cryptolib` is a Rust crate that exposes to Java, through JNI, the [ginger-lib](https://github.com/HorizenOfficial/ginger-lib) components needed by the [Zendoo](https://eprint.iacr.org/2020/123.pdf "Zendoo") sidechain SDK.
 
 In particular it exposes interfaces to:
 
 * handle the finite fields that are the alphabets of the zk Proving Systems
-* call the Poseidon function, a Snark friendly hashing algorithm
-* use a Poseidon-based Merkle Tree (calculate root, verify merkle path, ...)
-* compute and verify Schnorr signatures, handle associated keypairs
-* compute and verify a VRF proof, fetch a VRF output, handle associated keypairs (to support Ouroborous-style PoS sidechain consensus)
-* create and manage Zendoo Sidechain proofs
+* call the *Poseidon* function, a Snark friendly hashing algorithm
+* use a full in-memory *Poseidon-based Merkle Tree*, thus optimized for performance but limited in size (depending on the available RAM)
+* manage the *SCTxsCommitmentTree*, as described in section 4.1.3 of the [Zendoo](https://eprint.iacr.org/2020/123.pdf "Zendoo") paper
+* compute and verify *Schnorr* signatures, handle associated keypairs
+* compute and verify a VRF proof, fetch a VRF output, handle associated keypairs (to support *Ouroborous*-style PoS sidechain consensus)
+* create and manage *Zendoo* Sidechain proofs
 
 The library includes also an example of a simple Zendoo [sidechain proving circuit](demo-circuit) that can be used to create proofs for backward transfer certificates. This demo circuit can prove that a given certificate was signed by a minimum number of signers, all belonging to a defined set of approved signers. For more info, pls see the specific [document](doc).
 The circuit is offered as an example to developers, to help them build their own circuits, that will match their sidechain logic and needs.
 
 **Please note: the code is in development. No guarantees are provided about its security and functionality**
 
+## Release Notes
+
+The current release does not yet serve proof composition.
+The proving system has been switched from [Groth16](https://eprint.iacr.org/2016/260.pdf) to our Marlin variant [*Coboundary Marlin*](https://github.com/HorizenLabs/marlin).
+Support has been introduced to create *Final Darlin* proofs, as per last step of our recursive PCD scheme (See [HGB](https://eprint.iacr.org/2021/930) for details), but not yet implemented.
 
 ## Build guide
 
-The library can be built by using Cargo:
-
+The library compiles on the `1.51.0 stable` toolchain of the Rust compiler.
+To install Rust, first install `rustup` by following the instructions [here](https://rustup.rs/), or via your platform's package manager.
+Once `rustup` is installed, install the appropriate Rust toolchain by invoking:
+```bash
+rustup install 1.51.0
 ```
-	cargo build
-```  
-
-There are a few Rust tests that can be executed still with the usual Cargo command:  
 
+After that, use `cargo`, the standard Rust build tool, to build the library:
+```bash
+git clone https://github.com/HorizenOfficial/zendoo-sc-cryptolib.git
+cd zendoo-sc-cryptolib
+cargo build --release
 ```
-	cargo test
-```  
-
-
-## Contributing
-
-Contributions are welcomed! Bug fixes and new features can be initiated through GitHub pull requests. To speed the code review process, please adhere to the following guidelines:
-
-* Follow Horizen repositories' *code of conduct*
-* Follow Horizen repositories' *styling guide* 
-* Please gpg sign your commits 
-* Please make sure you push your pull requests to the development branch
-
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
-
-## License
-
-The code is licensed under the following license:
-
- * MIT license ([LICENSE-MIT](http://opensource.org/licenses/MIT) or http://opensource.org/licenses/MIT)
-
-Unless you explicitly state otherwise, any contribution submitted for inclusion in ginger-lib by you shall be licensed as above, without any additional terms or conditions.
-
-[![License MIT](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)
-
-
+This library comes with unit tests for each of the provided crates. Run the tests with:
+```bash
+cargo test
+``` 
+More detailed build guide, as well as instructions to build the .jar, can be found in in our [build guide](BUILD.md).

api/Cargo.toml

@@ -1,27 +1,40 @@
 [package]
 name = "api"
-version = "0.3.0"
-authors = ["DanieleDiBenedetto <daniele@horizenlabs.io>"]
+version = "0.4.0"
+authors = [
+    "DanieleDiBenedetto <daniele@horizenlabs.io>",
+    "Oleksandr Iozhytsia <oleksandr@zensystem.io>",
+    "Volodymyr Babaiev <volodymyr.babaiev@infopulse.com>",
+    "Maksym Vereshchak <phoinic@gmail.com>",
+    "Luigi Varriale <luigi@horizenlabs.io>",
+    "cronicc <cronic@horizenlabs.io>",
+]
 edition = "2018"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-algebra = { git = "https://github.com/HorizenOfficial/ginger-lib.git", tag = "0.2.0"}
-primitives = { features = ["merkle_tree", "signature", "vrf"], git = "https://github.com/HorizenOfficial/ginger-lib.git", tag = "0.2.0"}
-proof-systems = { features = ["groth16"], git = "https://github.com/HorizenOfficial/ginger-lib.git", tag = "0.2.0"}
+algebra = {features = ["tweedle"], git = "https://github.com/HorizenOfficial/ginger-lib.git", tag = "0.3.0"}
+primitives = {features = ["tweedle", "merkle_tree"], git = "https://github.com/HorizenOfficial/ginger-lib.git", tag = "0.3.0"}
 
-ouroboros = {path = "../ouroboros"}
+cctp_primitives = { git = "https://github.com/HorizenOfficial/zendoo-cctp-lib.git", tag = "0.1.0" }
+
+#ouroboros = {path = "../ouroboros"}
 demo-circuit = {path = "../demo-circuit"}
 
-jni = "0.6.1"
-derivative = "1"
+jni = "0.19.0"
+derivative = "2.2.0"
 lazy_static = "1"
-radix_trie = "0.1"
-rand = { version = "0.7" }
-rand_xorshift = { version = "0.2" }
+radix_trie = "0.2.1"
+rand = { version = "0.8.4" }
+rand_xorshift = { version = "0.3.0" }
+blake2 = { version = "0.8.1", default-features = false }
 
 [lib]
 name = "zendoo_sc"
 path = "src/lib.rs"
 crate_type = ["cdylib"]
+
+[features]
+default = [ "asm" ]
+asm = [ "algebra/llvm_asm", "cctp_primitives/asm", "demo-circuit/asm" ]