docs(zkit): update README.md (#149)

* chore: fix typos in docs and logs

* docs(zkit): update README.md

Author: vuittont60

SM/src/sm/sm_main/sm_main_exec.js

@@ -1018,7 +1018,7 @@ console.log("fastDebugExit: ", ctx.zkPC, rom.labels)
             if ((typeof ctx.hashK[addr].reads[pos] !== "undefined") &&
                 (ctx.hashK[addr].reads[pos] != size))
             {
-                throw new Error(`HashK(${addr}) diferent read sizes (${ctx.hashK[addr].reads[pos]} != ${size}) in the same position ${pos} ${sourceRef}`)
+                throw new Error(`HashK(${addr}) different read sizes (${ctx.hashK[addr].reads[pos]} != ${size}) in the same position ${pos} ${sourceRef}`)
             }
             ctx.hashK[addr].reads[pos] = size;
             incHashPos = size;
@@ -1094,7 +1094,7 @@ console.log("fastDebugExit: ", ctx.zkPC, rom.labels)
             if ((typeof ctx.hashP[addr].reads[pos] !== "undefined") &&
                 (ctx.hashP[addr].reads[pos] != size))
             {
-                throw new Error(`HashP(${addr}) diferent read sizes in the same position ${pos} (${ctx.hashP[addr].reads[pos]} != ${size}) ${sourceRef}`);
+                throw new Error(`HashP(${addr}) different read sizes in the same position ${pos} (${ctx.hashP[addr].reads[pos]} != ${size}) ${sourceRef}`);
             }
             ctx.hashP[addr].reads[pos] = size;
             incHashPos = size;
@@ -2057,7 +2057,7 @@ function assertOutputs(ctx){
         throw new Error("Assert Error: newNumBatch does not match");
     }
 
-    console.log("Assert outputs run succesfully");
+    console.log("Assert outputs run successfully");
 }
 
 

stark-circuits/README.md

@@ -4,7 +4,7 @@ Stark circuit is the valilla Stark verifier implementation atop both BN254 and B
 This code orignals from [Hermez pil-stark](https://github.com/0xPolygonHermez/pil-stark), and here we generalize the basic blocks for big fields, using `eSize` as the number of Godilocks elements to indicate one of big field.
 
 
-For the [recursion-aggregation-composition architechure](../docs/recursion-aggregation-composition.png)(source: p14, [proof-recursion](https://github.com/0xPolygonHermez/zkevm-techdocs/blob/main/proof-recursion/v.1.1/proof-recursion.pdf)), the final stage is generated atop big field for final verification on L1, like Ethereum or Cardano, which means that before final stage, all computation are atop Godilocks, when into the final stage, it verifys the Snark proof of stark's verification computation atop big field.
+For the [recursion-aggregation-composition architecture](../docs/recursion-aggregation-composition.png)(source: p14, [proof-recursion](https://github.com/0xPolygonHermez/zkevm-techdocs/blob/main/proof-recursion/v.1.1/proof-recursion.pdf)), the final stage is generated atop big field for final verification on L1, like Ethereum or Cardano, which means that before final stage, all computation are atop Godilocks, when into the final stage, it verifys the Snark proof of stark's verification computation atop big field.
 
 ## Basic Blocks
 
@@ -24,7 +24,7 @@ For the [recursion-aggregation-composition architechure](../docs/recursion-aggre
 ### Irreducible polinomial
 
 For the element mapping from Goldilocks field to Scalar field of BLS12-381, a field switch is need.
-The scalar field of bls381 could be presented by 5-64bits, by refering to the switch for Godilocks-BN254, we choose the valilla Irreducible Polynomail atop [$GF_{p^5}$](https://github.com/pornin/ecgfp5).
+The scalar field of bls381 could be presented by 5-64bits, by referring to the switch for Godilocks-BN254, we choose the valilla Irreducible Polynomail atop [$GF_{p^5}$](https://github.com/pornin/ecgfp5).
 
 * BN254: `x^3 - x - 1`
 * BLS12-381: `x^5 - 3`
@@ -103,7 +103,7 @@ Observe that the multiplication and inversion for scalar field in BN254 and BLS1
 ### Merkle
 
 For the Merkel Circuit, each leaf is N-elements on GL field, where N is 4 for BN254, and 6 for BLS12-381. Before we calculate the merkle root, we need convert the N-elements to one element in big field.
-As a refernece, [to\_bn128](https://github.com/0xEigenLabs/eigen-zkvm/blob/main/starky/src/digest.rs#L73) is present, and same conversion should be applied to bls-12381.
+As a reference, [to\_bn128](https://github.com/0xEigenLabs/eigen-zkvm/blob/main/starky/src/digest.rs#L73) is present, and same conversion should be applied to bls-12381.
 
 ## ElementDigest
 

zkit/README.md

@@ -15,22 +15,27 @@ FLAGS:
     -V, --version    Prints version information
 
 SUBCOMMANDS:
-    aggregation_check                      Check aggregation proof
-    aggregation_prove                      Proof aggregation for plonk
-    aggregation_verify                     Verify aggregation proof
-    analyse                                Analyse circuits
-    calculate_witness                      Calculate witness and save to output file
-    compile                                Compile circom circuits to r1cs, and generate witness
-    export_aggregation_verification_key    Export aggregation proof's verification key
-    export_verification_key                Export proof's verification key
-    generate_aggregation_verifier          A subcommand for generating a Solidity aggregation verifier smart
-                                           contract
-    generate_verifier                      Generate solidity verifier
-    help                                   Prints this message or the help of the given subcommand(s)
-    prove                                  Prove by Plonk
-    setup                                  Trust setup for Plonk
-    stark_prove                            Stark proving and verifying all in one
-    verify                                 Verify the Plonk proof
+    aggregation_check                    Check aggregation proof
+    aggregation_prove                    Proof aggregation for plonk
+    aggregation_verify                   Verify aggregation proof
+    analyse                              Analyse circuits
+    calculate_witness                    Calculate witness and save to output file
+    compile                              Compile circom circuits to r1cs, and generate witness
+    compressor12_exec                    Exec compressor12 for converting R1CS to PIL
+    compressor12_setup                   Setup compressor12 for converting R1CS to PIL
+    export_aggregation_verification_key  Export aggregation proof's verification key
+    export_verification_key              Export proof's verification key
+    generate_aggregation_verifier        A subcommand for generating a Solidity aggregation verifier smart contract
+    generate_verifier                    Generate solidity verifier
+    groth16_prove                        Prove with groth16
+    groth16_setup                        Setup groth16
+    groth16_verify                       Verify with groth16
+    help                                 Print this message or the help of the given subcommand(s)
+    join_zkin                            generate the input1.zkin.json and input2.zkin.json into out.zkin.json
+    prove                                Prove by Plonk
+    setup                                Trust setup for Plonk
+    stark_prove                          Stark proving and verifying all in one
+    verify                               Verify the Plonk proof
 ```
 
 The recursive proof example can be found [here](../starkjs).