Merge pull request #1 from ingonyama-zk/fix/cleanup

Flattening and condensing repo
ingonyama-zk · Mar 8, 2023 · 4c94223 · 4c94223
2 parents 7a88354 + 6d624c6
commit 4c94223
Show file tree

Hide file tree

Showing 63 changed files with 110 additions and 256 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,3 +1,28 @@
-[workspace]
+[package]
+name = "icicle-utils"
+version = "0.1.0"
+edition = "2021"
+authors = [ "Ingonyama" ]
+description = "An implementation of the Ingonyama Cuda Library"
+homepage = "https://www.ingonyama.com"
+repository = "https://github.com/ingonyama-zk/icicle"
 
-members=["wrapper/icicle-utils"]
+[dependencies] 
+hex="*"
+ark-std = "0.3.0"
+ark-ff = "0.3.0"
+ark-poly = "0.3.0"
+ark-ec = { version = "0.3.0", features = [ "parallel" ] }
+ark-bls12-381 = { version = "0.3.0", optional = true }
+
+rand="*" #TODO: sort dependencies that are not required by the release
+
+[build-dependencies]
+cc = { version = "1.0", features = ["parallel"] }
+
+[dev-dependencies]
+rand="*"
+
+[features]
+default = ["bls12_381"]
+bls12_381 = ["ark-bls12-381/curve"]
diff --git a/README.md b/README.md
@@ -4,15 +4,86 @@
                   
 ![image (4)](https://user-images.githubusercontent.com/2446179/223707486-ed8eb5ab-0616-4601-8557-12050df8ccf7.png)
 
+## Background
+
+Zero Knowledge Proofs (ZKPs) are considered one of the greatest achievements of modern cryptography. Accordingly, ZKPs are expected to disrupt a number of industries and will usher in an era of trustless and privacy preserving services and infrastructure.
+
+If we want ZK hardware today we have FPGAs or GPUs which are relatively inexpensive. However, the biggest selling point of GPUs is the software; we talk in particular about CUDA, which makes it easy to write code running on Nvidia GPUs, taking advantage of their highly parallel architecture. Together with the widespread availability of these devices, if we can get GPUs to work on ZK workloads, then we have made a giant step towards accessible and efficient ZK provers.
+
+## Zero Knowledge on GPU
+
+ICICLE is a CUDA implementation of general functions widely used in ZKP. ICICLE currently provides support for MSM, NTT, and ECNTT, with plans to support Hash functons soon.
+
+### Supported primitives
+
+- Fields
+    - Scalars
+    - Points
+        - Projective: {x, y, z}
+        - Affine: {x, y}
+- Curves
+    - [BLS12-381]
+
+> NOTE: _Support for BN254 and BLS12-377 are planned_
+
+## Build and usage
+
+> NOTE: [NVCC] is a prerequisite for building.
+
+1. Define or select a curve for your application; we've provided a [template][CRV_TEMPLATE] for defining a curve
+2. Include the curve in [`curve_config.cuh`][CRV_CONFIG]
+3. Now you can build the ICICLE library using nvcc
+
+```sh
+mkdir -p build
+nvcc -o build/<ENTER_DIR_NAME> icicle/lib.cu
+```
+
+### Rust Bindings
+
+For convenience, we also provide rust bindings to the ICICLE library for the following primitives:
+
+- MSM
+- NTT
+    - Forward NTT
+    - Inverse NTT
+- ECNTT
+    - Forward ECNTT
+    - Inverse NTT
+- Scalar Vector Multiplication
+- Point Vector Multiplication
+
+A custom [build script][B_SCRIPT] is used to compile and link the ICICLE library. Make sure to change the `arch` flag depending on your GPU type or leave it as `native` for the compiler to detect the installed GPU type.
+
+Once you have your parameters set, run:
+
+```sh
+cargo build --release
+```
+
+You'll find a release ready library at `target/release/libicicle_utils.rlib`.
+
+### Example Usage
+
+An example of using the Rust bindings library can be found in our [fast-danksharding implementation][FDI]
 
-## Usage
-We provide two ways to interact with the library. Check the links for more details: 
-1. [Rust API](/wrapper)
-2. [CUDA interface](/cuda) 
 
 ## Contributions
+
 Join our [Discord Server](https://discord.gg/Y4SkbDf2Ff) and find us on the icicle channel. We will be happy to work together to support your use case and talk features, bugs and design.
 
 ## License
-Icicle is distributed under the terms of the MIT License.
 
+ICICLE is distributed under the terms of the MIT License.
+
+See [LICENSE-MIT][LMIT] for details.
+
+<!-- Begin Links -->
+[BLS12-381]: ./icicle/curves/bls12_381.cuh
+[NVCC]: https://docs.nvidia.com/cuda/#installation-guides
+[CRV_TEMPLATE]: ./icicle/curves/curve_template.cuh
+[CRV_CONFIG]: ./icicle/curves/curve_config.cuh
+[B_SCRIPT]: ./build.rs
+[FDI]: https://github.com/ingonyama-zk/fast-danksharding
+[LMIT]: ./LICENSE
+<!-- End Links -->
diff --git a/wrapper/icicle-utils/build.rs → build.rs b/wrapper/icicle-utils/build.rs → build.rs
@@ -3,13 +3,13 @@ fn main() {
     //TODO: can conflict/duplicate with make ?
 
     println!("cargo:rerun-if-env-changed=CXXFLAGS");
-    println!("cargo:rerun-if-changed=../../cuda");
+    println!("cargo:rerun-if-changed=./icicle");
 
     let mut nvcc = cc::Build::new();
 
     nvcc.cuda(true);
     nvcc.debug(false);
     nvcc.flag("-arch=native");
-    nvcc.file("../lib.cu").compile("ingo_icicle"); //TODO: extension??
+    nvcc.file("./icicle/lib.cu").compile("ingo_icicle"); //TODO: extension??
 
 }
diff --git a/cuda/README.md b/cuda/README.md
diff --git a/cuda/appUtils/msm/msm.cu → icicle/appUtils/msm/msm.cu b/cuda/appUtils/msm/msm.cu → icicle/appUtils/msm/msm.cu
diff --git a/cuda/appUtils/msm/msm.cuh → icicle/appUtils/msm/msm.cuh b/cuda/appUtils/msm/msm.cuh → icicle/appUtils/msm/msm.cuh
diff --git a/cuda/appUtils/ntt/main_ec.cu → icicle/appUtils/ntt/main_ec.cu b/cuda/appUtils/ntt/main_ec.cu → icicle/appUtils/ntt/main_ec.cu
diff --git a/cuda/appUtils/ntt/main_scalar.cu → icicle/appUtils/ntt/main_scalar.cu b/cuda/appUtils/ntt/main_scalar.cu → icicle/appUtils/ntt/main_scalar.cu
diff --git a/cuda/appUtils/ntt/ntt.cuh → icicle/appUtils/ntt/ntt.cuh b/cuda/appUtils/ntt/ntt.cuh → icicle/appUtils/ntt/ntt.cuh
diff --git a/cuda/appUtils/ntt/unified_test.cu → icicle/appUtils/ntt/unified_test.cu b/cuda/appUtils/ntt/unified_test.cu → icicle/appUtils/ntt/unified_test.cu
diff --git a/...pUtils/vector_manipulation/ve_mod_mult.cu → ...pUtils/vector_manipulation/ve_mod_mult.cu b/...pUtils/vector_manipulation/ve_mod_mult.cu → ...pUtils/vector_manipulation/ve_mod_mult.cu
diff --git a/...Utils/vector_manipulation/ve_mod_mult.cuh → ...Utils/vector_manipulation/ve_mod_mult.cuh b/...Utils/vector_manipulation/ve_mod_mult.cuh → ...Utils/vector_manipulation/ve_mod_mult.cuh
diff --git a/cuda/curves/bls12_381.cuh → icicle/curves/bls12_381.cuh b/cuda/curves/bls12_381.cuh → icicle/curves/bls12_381.cuh
diff --git a/cuda/curves/curve_config.cuh → icicle/curves/curve_config.cuh b/cuda/curves/curve_config.cuh → icicle/curves/curve_config.cuh
diff --git a/cuda/curves/curve_template.cuh → icicle/curves/curve_template.cuh b/cuda/curves/curve_template.cuh → icicle/curves/curve_template.cuh
diff --git a/icicle/lib.cu b/icicle/lib.cu
@@ -0,0 +1,5 @@
+#include "./appUtils/msm/msm.cuh"
+#include "./appUtils/ntt/ntt.cuh"
+#include "./appUtils/vector_manipulation/ve_mod_mult.cu"
+#include "./appUtils/vector_manipulation/ve_mod_mult.cuh"
+
diff --git a/cuda/primitives/affine.cuh → icicle/primitives/affine.cuh b/cuda/primitives/affine.cuh → icicle/primitives/affine.cuh
diff --git a/cuda/primitives/base_curve.cuh → icicle/primitives/base_curve.cuh b/cuda/primitives/base_curve.cuh → icicle/primitives/base_curve.cuh
diff --git a/cuda/primitives/projective.cuh → icicle/primitives/projective.cuh b/cuda/primitives/projective.cuh → icicle/primitives/projective.cuh
diff --git a/cuda/utils/cuda_utils.cuh → icicle/utils/cuda_utils.cuh b/cuda/utils/cuda_utils.cuh → icicle/utils/cuda_utils.cuh
diff --git a/cuda/utils/host_math.cuh → icicle/utils/host_math.cuh b/cuda/utils/host_math.cuh → icicle/utils/host_math.cuh
diff --git a/cuda/utils/objects.cuh → icicle/utils/objects.cuh b/cuda/utils/objects.cuh → icicle/utils/objects.cuh
diff --git a/cuda/utils/ptx.cuh → icicle/utils/ptx.cuh b/cuda/utils/ptx.cuh → icicle/utils/ptx.cuh
diff --git a/cuda/utils/storage.cuh → icicle/utils/storage.cuh b/cuda/utils/storage.cuh → icicle/utils/storage.cuh
diff --git a/wrapper/icicle-utils/src/field.rs → src/field.rs b/wrapper/icicle-utils/src/field.rs → src/field.rs
diff --git a/wrapper/icicle-utils/src/lib.rs → src/lib.rs b/wrapper/icicle-utils/src/lib.rs → src/lib.rs
diff --git a/wrapper/icicle-utils/src/matrix.rs → src/matrix.rs b/wrapper/icicle-utils/src/matrix.rs → src/matrix.rs
diff --git a/wrapper/icicle-utils/src/utils.rs → src/utils.rs b/wrapper/icicle-utils/src/utils.rs → src/utils.rs
diff --git a/wrapper/data/test_vectors/B0.csv → test_vectors/B0.csv b/wrapper/data/test_vectors/B0.csv → test_vectors/B0.csv
diff --git a/wrapper/data/test_vectors/B1.csv → test_vectors/B1.csv b/wrapper/data/test_vectors/B1.csv → test_vectors/B1.csv
diff --git a/wrapper/data/test_vectors/C.csv → test_vectors/C.csv b/wrapper/data/test_vectors/C.csv → test_vectors/C.csv
diff --git a/wrapper/data/test_vectors/C0.csv → test_vectors/C0.csv b/wrapper/data/test_vectors/C0.csv → test_vectors/C0.csv
diff --git a/wrapper/data/test_vectors/C2.csv → test_vectors/C2.csv b/wrapper/data/test_vectors/C2.csv → test_vectors/C2.csv
diff --git a/wrapper/data/test_vectors/C_rows.csv → test_vectors/C_rows.csv b/wrapper/data/test_vectors/C_rows.csv → test_vectors/C_rows.csv
diff --git a/wrapper/data/test_vectors/D.csv → test_vectors/D.csv b/wrapper/data/test_vectors/D.csv → test_vectors/D.csv
diff --git a/wrapper/data/test_vectors/D_b4rbo.csv → test_vectors/D_b4rbo.csv b/wrapper/data/test_vectors/D_b4rbo.csv → test_vectors/D_b4rbo.csv
diff --git a/wrapper/data/test_vectors/D_both.csv → test_vectors/D_both.csv b/wrapper/data/test_vectors/D_both.csv → test_vectors/D_both.csv
diff --git a/wrapper/data/test_vectors/D_cols.csv → test_vectors/D_cols.csv b/wrapper/data/test_vectors/D_cols.csv → test_vectors/D_cols.csv
diff --git a/wrapper/data/test_vectors/D_in.csv → test_vectors/D_in.csv b/wrapper/data/test_vectors/D_in.csv → test_vectors/D_in.csv
diff --git a/wrapper/data/test_vectors/D_rows.csv → test_vectors/D_rows.csv b/wrapper/data/test_vectors/D_rows.csv → test_vectors/D_rows.csv
diff --git a/wrapper/data/test_vectors/E0.csv → test_vectors/E0.csv b/wrapper/data/test_vectors/E0.csv → test_vectors/E0.csv
diff --git a/wrapper/data/test_vectors/E1.csv → test_vectors/E1.csv b/wrapper/data/test_vectors/E1.csv → test_vectors/E1.csv
diff --git a/wrapper/data/test_vectors/E2.csv → test_vectors/E2.csv b/wrapper/data/test_vectors/E2.csv → test_vectors/E2.csv
diff --git a/wrapper/data/test_vectors/K.csv → test_vectors/K.csv b/wrapper/data/test_vectors/K.csv → test_vectors/K.csv
diff --git a/wrapper/data/test_vectors/K0.csv → test_vectors/K0.csv b/wrapper/data/test_vectors/K0.csv → test_vectors/K0.csv
diff --git a/wrapper/data/test_vectors/K1.csv → test_vectors/K1.csv b/wrapper/data/test_vectors/K1.csv → test_vectors/K1.csv
diff --git a/wrapper/data/test_vectors/P.csv → test_vectors/P.csv b/wrapper/data/test_vectors/P.csv → test_vectors/P.csv
diff --git a/wrapper/data/test_vectors/S.csv → test_vectors/S.csv b/wrapper/data/test_vectors/S.csv → test_vectors/S.csv
diff --git a/wrapper/data/test_vectors/SRS.csv → test_vectors/SRS.csv b/wrapper/data/test_vectors/SRS.csv → test_vectors/SRS.csv
diff --git a/wrapper/data/test_vectors/d0.csv → test_vectors/d0.csv b/wrapper/data/test_vectors/d0.csv → test_vectors/d0.csv
diff --git a/wrapper/data/test_vectors/d1.csv → test_vectors/d1.csv b/wrapper/data/test_vectors/d1.csv → test_vectors/d1.csv
diff --git a/wrapper/data/test_vectors/d2.csv → test_vectors/d2.csv b/wrapper/data/test_vectors/d2.csv → test_vectors/d2.csv
diff --git a/wrapper/data/test_vectors/q.csv → test_vectors/q.csv b/wrapper/data/test_vectors/q.csv → test_vectors/q.csv
diff --git a/wrapper/data/test_vectors/roots32.csv → test_vectors/roots32.csv b/wrapper/data/test_vectors/roots32.csv → test_vectors/roots32.csv
diff --git a/wrapper/data/test_vectors/roots512.csv → test_vectors/roots512.csv b/wrapper/data/test_vectors/roots512.csv → test_vectors/roots512.csv
diff --git a/wrapper/CONTRIBUTING.md b/wrapper/CONTRIBUTING.md
diff --git a/wrapper/README.md b/wrapper/README.md
diff --git a/wrapper/icicle-utils/Cargo.lock b/wrapper/icicle-utils/Cargo.lock
diff --git a/wrapper/icicle-utils/Cargo.toml b/wrapper/icicle-utils/Cargo.toml
diff --git a/wrapper/icicle-utils/setup_files_format.txt b/wrapper/icicle-utils/setup_files_format.txt
diff --git a/wrapper/icicle-utils/src/main.rs b/wrapper/icicle-utils/src/main.rs
diff --git a/wrapper/lib.cu b/wrapper/lib.cu