Fix: Docs, Curve generation script

README.md

@@ -4,6 +4,13 @@
 
 ![image (4)](https://user-images.githubusercontent.com/2446179/223707486-ed8eb5ab-0616-4601-8557-12050df8ccf7.png)
 
+
+<div align="center">
+![Build status](https://github.com/ingonyama-zk/icicle/actions/workflows/buil.yml/badge.svg)
+![Discord server](https://img.shields.io/discord/1063033227788423299?label=Discord&logo=Discord&logoColor=%23&style=plastic)
+![Follow us on twitter](https://img.shields.io/twitter/follow/Ingo_zk?style=social)
+</div>
+
 ## 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.
@@ -36,7 +43,7 @@ ICICLE is a CUDA implementation of general functions widely used in ZKP. ICICLE
 
 ```sh
 mkdir -p build
-nvcc -o build/<ENTER_DIR_NAME> ./icicle/appUtils/ntt/ntt.cu ./icicle/appUtils/msm/msm.cu ./icicle/appUtils/vector_manipulation/ve_mod_mult.cu ./icicle/primitives/projective.cu -lib -arch=native
+nvcc -o build/<binary_name> ./icicle/curves/index.cu -lib -arch=native
 ```
 
 ### Testing the CUDA code
@@ -95,52 +102,64 @@ Supporting additional curves can be done as follows:
 
 Create a JSON file with the curve parameters. The curve is defined by the following parameters: 
 - ``curve_name`` - e.g. ``bls12_381``.
-- ``modolus_p`` - scalar field modolus (in decimal).
-- ``bit_count_p`` - number of bits needed to represent `` modolus_p`` .
-- ``limb_p`` - number of bytes needed to represent `` modolus_p``  (rounded).
+- ``modulus_p`` - scalar field modulus (in decimal).
+- ``bit_count_p`` - number of bits needed to represent `` modulus_p`` .
+- ``limb_p`` - number of bytes needed to represent `` modulus_p``  (rounded).
 - ``ntt_size`` - log of the maximal size subgroup of the scalar field.    
-- ``modolus_q`` - base field modulus (in decimal).
-- ``bit_count_q`` - number of bits needed to represent `` modolus_q`` .
-- ``limb_q`` number of bytes needed to represent `` modolus_p``  (rounded).
+- ``modulus_q`` - base field modulus (in decimal).
+- ``bit_count_q`` - number of bits needed to represent `` modulus_q`` .
+- ``limb_q`` number of bytes needed to represent `` modulus_p``  (rounded).
 - ``weierstrass_b`` - Weierstrauss constant of the curve. 
+- ``weierstrass_b_g2_re`` - Weierstrauss real constant of the g2 curve. 
+- ``weierstrass_b_g2_im`` - Weierstrauss imaginary constant of the g2 curve. 
 - ``gen_x`` - x-value of a generator element for the curve. 
 - ``gen_y`` - y-value of a generator element for the curve.
+- ``gen_x_re`` - real x-value of a generator element for the g2 curve. 
+- ``gen_x_im`` - imaginary x-value of a generator element for the g2 curve. 
+- ``gen_y_re`` - real y-value of a generator element for the g2 curve. 
+- ``gen_y_im`` - imaginary y-value of a generator element for the g2 curve. 
 
 Here's an example for BLS12-381.
 ```
 {
     "curve_name" : "bls12_381", 
-    "modolus_p" : 52435875175126190479447740508185965837690552500527637822603658699938581184513,
+    "modulus_p" : 52435875175126190479447740508185965837690552500527637822603658699938581184513,
     "bit_count_p" : 255,
     "limb_p" :  8,
     "ntt_size" : 32,
-    "modolus_q" : 4002409555221667393417789825735904156556882819939007885332058136124031650490837864442687629129015664037894272559787,
+    "modulus_q" : 4002409555221667393417789825735904156556882819939007885332058136124031650490837864442687629129015664037894272559787,
     "bit_count_q" : 381,
     "limb_q" : 12,
     "weierstrass_b" : 4,
+    "weierstrass_b_g2_re":4,
+    "weierstrass_b_g2_im":4,
     "gen_x" : 3685416753713387016781088315183077757961620795782546409894578378688607592378376318836054947676345821548104185464507,
-    "gen_y" : 1339506544944476473020471379941921221584933875938349620426543736416511423956333506472724655353366534992391756441569
+    "gen_y" : 1339506544944476473020471379941921221584933875938349620426543736416511423956333506472724655353366534992391756441569,
+    "gen_x_re" : 352701069587466618187139116011060144890029952792775240219908644239793785735715026873347600343865175952761926303160,
+    "gen_x_im" : 3059144344244213709971259814753781636986470325476647558659373206291635324768958432433509563104347017837885763365758,
+    "gen_y_re" : 1985150602287291935568054521177171638300868978215655730859378665066344726373823718423869104263333984641494340347905,
+    "gen_y_im" : 927553665492332455747201965776037880757740193453592970025027978793976877002675564980949289727957565575433344219582
 }
 ```
 
-Save the parameters JSON file in ``curve_parameters``.
+Save the parameters JSON file under the ``curve_parameters`` directory.
 
-Then run the Python script ``new_curve_script.py `` from the main icicle folder:
+Then run the Python script ``new_curve_script.py `` from the root folder:
 
 ```
-python3 ./curve_parameters/new_curve_script_rust.py ./curve_parameters/bls12_381.json
+python3 ./curve_parameters/new_curve_script.py ./curve_parameters/bls12_381.json
 ```
 
 The script does the following:
 - Creates a folder in ``icicle/curves`` with the curve name, which contains all of the files needed for the supported operations in cuda.
-- Adds the curve exported operations to ``icicle/curves/index.cu``. 
+- Adds the curve's exported operations to ``icicle/curves/index.cu``. 
 - Creates a file with the curve name in ``src/curves`` with the relevant objects for the curve. 
 - Creates a test file with the curve name in ``src``. 
 
 Testing the new curve could be done by running the tests in ``tests_curve_name`` (e.g. ``tests_bls12_381``).
 ## 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.
+Join our [Discord Server][DISCORD] 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.
 
 ### Hall of Fame
 
@@ -153,13 +172,16 @@ 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
+[BLS12-381]: ./icicle/curves/bls12_381/supported_operations.cu
+[BLS12-377]: ./icicle/curves/bls12_377/supported_operations.cu
+[BN254]: ./icicle/curves/bn254/supported_operations.cu
 [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
+[DISCORD]: https://discord.gg/Y4SkbDf2Ff
 [googletest]: https://github.com/google/googletest/
 
 <!-- End Links -->

curve_parameters/bls12_377.json

@@ -1,13 +1,20 @@
 {
     "curve_name" : "bls12_377",
-    "modolus_p" : 8444461749428370424248824938781546531375899335154063827935233455917409239041,
+    "modulus_p" : 8444461749428370424248824938781546531375899335154063827935233455917409239041,
     "bit_count_p" : 253,
     "limb_p" :  8,
     "ntt_size" : 32,
-    "modolus_q" : 258664426012969094010652733694893533536393512754914660539884262666720468348340822774968888139573360124440321458177,
+    "modulus_q" : 258664426012969094010652733694893533536393512754914660539884262666720468348340822774968888139573360124440321458177,
     "bit_count_q" : 377,
     "limb_q" : 12,
+    "root_of_unity" : 5928890464389279575069867463136436689218492512582288454256978381122364252082,
     "weierstrass_b" : 1,
-    "gen_x" : 81937999373150964239938255573465948239988671502647976594219695644855304257327692006745978603320413799295628339695,
-    "gen_y" : 241266749859715473739788878240585681733927191168601896383759122102112907357779751001206799952863815012735208165030
+    "weierstrass_b_g2_re" : 0,
+    "weierstrass_b_g2_im" : 155198655607781456406391640216936120121836107652948796323930557600032281009004493664981332883744016074664192874906,
+    "g1_gen_x" : 81937999373150964239938255573465948239988671502647976594219695644855304257327692006745978603320413799295628339695,
+    "g1_gen_y" : 241266749859715473739788878240585681733927191168601896383759122102112907357779751001206799952863815012735208165030,
+    "g2_gen_x_re" : 233578398248691099356572568220835526895379068987715365179118596935057653620464273615301663571204657964920925606294,
+    "g2_gen_x_im" : 140913150380207355837477652521042157274541796891053068589147167627541651775299824604154852141315666357241556069118,
+    "g2_gen_y_re" : 63160294768292073209381361943935198908131692476676907196754037919244929611450776219210369229519898517858833747423,
+    "g2_gen_y_im" : 149157405641012693445398062341192467754805999074082136895788947234480009303640899064710353187729182149407503257491
 }

curve_parameters/bls12_381.json

@@ -1,13 +1,20 @@
 {
     "curve_name" : "bls12_381",
-    "modolus_p" : 52435875175126190479447740508185965837690552500527637822603658699938581184513,
+    "modulus_p" : 52435875175126190479447740508185965837690552500527637822603658699938581184513,
     "bit_count_p" : 255,
     "limb_p" :  8,
     "ntt_size" : 32,
-    "modolus_q" : 4002409555221667393417789825735904156556882819939007885332058136124031650490837864442687629129015664037894272559787,
+    "modulus_q" : 4002409555221667393417789825735904156556882819939007885332058136124031650490837864442687629129015664037894272559787,
     "bit_count_q" : 381,
     "limb_q" : 12,
+    "root_of_unity" : 937917089079007706106976984802249742464848817460758522850752807661925904159,
     "weierstrass_b" : 4,
-    "gen_x" : 3685416753713387016781088315183077757961620795782546409894578378688607592378376318836054947676345821548104185464507,
-    "gen_y" : 1339506544944476473020471379941921221584933875938349620426543736416511423956333506472724655353366534992391756441569
+    "weierstrass_b_g2_re":4,
+    "weierstrass_b_g2_im":4,
+    "g1_gen_x" : 3685416753713387016781088315183077757961620795782546409894578378688607592378376318836054947676345821548104185464507,
+    "g1_gen_y" : 1339506544944476473020471379941921221584933875938349620426543736416511423956333506472724655353366534992391756441569,
+    "g2_gen_x_re" : 352701069587466618187139116011060144890029952792775240219908644239793785735715026873347600343865175952761926303160,
+    "g2_gen_x_im" : 3059144344244213709971259814753781636986470325476647558659373206291635324768958432433509563104347017837885763365758,
+    "g2_gen_y_re" : 1985150602287291935568054521177171638300868978215655730859378665066344726373823718423869104263333984641494340347905,
+    "g2_gen_y_im" : 927553665492332455747201965776037880757740193453592970025027978793976877002675564980949289727957565575433344219582
 }

curve_parameters/bn254.json

@@ -1,13 +1,20 @@
 {
     "curve_name" : "bn254",
-    "modolus_p" : 21888242871839275222246405745257275088548364400416034343698204186575808495617,
+    "modulus_p" : 21888242871839275222246405745257275088548364400416034343698204186575808495617,
     "bit_count_p" : 254,
     "limb_p" :  8,
-    "ntt_size" : 16,
-    "modolus_q" : 21888242871839275222246405745257275088696311157297823662689037894645226208583,
+    "ntt_size" : 28,
+    "modulus_q" : 21888242871839275222246405745257275088696311157297823662689037894645226208583,
     "bit_count_q" : 254,
     "limb_q" : 8,
+    "root_of_unity" : 19103219067921713944291392827692070036145651957329286315305642004821462161904,
     "weierstrass_b" : 3,
-    "gen_x" : 1,
-    "gen_y" : 2
+    "weierstrass_b_g2_re" : 19485874751759354771024239261021720505790618469301721065564631296452457478373,
+    "weierstrass_b_g2_im" : 266929791119991161246907387137283842545076965332900288569378510910307636690,
+    "g1_gen_x" : 1,
+    "g1_gen_y" : 2,
+    "g2_gen_x_re" : 10857046999023057135944570762232829481370756359578518086990519993285655852781,
+    "g2_gen_x_im" : 11559732032986387107991004021392285783925812861821192530917403151452391805634,
+    "g2_gen_y_re" : 8495653923123431417604973247489272438418190587263600148770280649306958101930,
+    "g2_gen_y_im" : 4082367875863433681332203403145435568316851327593401208105741076214120093531
 }