The library consists of circom circuits that extend the capabilities of solarity/solidity-lib to be used in magnificent ZK applications.
$ npm install @solarity/circom-lib
[!NOTE] You will need circom binary preinstalled to be able to compile the circuits.
You can compile the circuits in the project by executing the following command:
$ npm run compile
The compilation includes the generation of
r1cs
file,zkey
, and scripts to produce the correspondingwitnesses
.
Run the following command in order to generate the solidity verifier contracts:
$ npm run circom-verifier
[!TIP] All essential circuit-related information is stored in the
circuit.config.json
file.
The library is released under the MIT License.