diff --git a/libs/remix-ws-templates/src/templates/semaphore/README.md b/libs/remix-ws-templates/src/templates/semaphore/README.md index 12631585c2..d75ceec145 100644 --- a/libs/remix-ws-templates/src/templates/semaphore/README.md +++ b/libs/remix-ws-templates/src/templates/semaphore/README.md @@ -14,13 +14,13 @@ The workspace comprises two main directories: #### 1) compile the semaphore circuit using the remix circom compiler. This will generate artifacts. #### 2) execute the file `run_setup.ts`: -This step generate a verification key that can be used for generating proof, it will also generate a Solidity contract for on-chain verification. +This step generates a verification key that can be used for generating proof, it will also generate a Solidity contract for on-chain verification. Note that this section should only be used for development purposes as this way of running the setup is heavily centralized (although some pieces of this script can be used to achieve that). This generates a verification key (`./zk/build/verification_key.json`) and artifacts from the setup (`./zk/build/zk_setup.txt`). #### 3) execute the file `run_verification.ts`: This script: - - create a list of identity commitments and add it to a `IncrementalMerkleTree`. The tree is used to generate a merkle proof that a specified identity is actually in the tree (see`tree.createProof(0)`). + - create a list of identity commitments and add it to a `IncrementalMerkleTree`. The tree is used to generate a merkle proof that a specified identity is actually in the tree (see `tree.createProof(0)`). - generate a witness and a proof of execution. - verify that the proof is valid `(snarkjs.groth16.verify)` - - ultimately verify that the hash generated by the circom compiler is the same as the root hash for the Tree. `(proof1.root.toString() === publicSignals[0]`). This assert that the identity provided to the circuit is actually part of that semaphore group. \ No newline at end of file + - ultimately verify that the hash generated by the circom compiler is the same as the root hash for the Tree. `(proof1.root.toString() === publicSignals[0]`). This asserts that the identity provided to the circuit is actually part of that semaphore group.