arnaucube
arnaucube/snarkjsPublic Self-hosted repository
Added JS style syntaxing to README
Ghilia Weldesselasie ghiliaweld@gmail.com
Fri, 14 Sep 2018 08:27:36 -0400
commit

280cdd77872609ac5de3e4dcee1f46e683a5ca0b

parent

33439811877d557837fa43703c896c63ff377700

1 files changed, 7 insertions(+), 7 deletions(-)

jump to
M README.md → README.md

@@ -8,7 +8,7 @@ This library uses the compiled circuits generated by the jaz compiler.

## Install. -``` +```sh npm install zksnark ```

@@ -16,13 +16,13 @@ ## Usage.

### Import. -``` +```js const zkSnark = require("zksnark"); ``` ### Load a circuit. -``` +```js // "myCircuit.cir" is the output of the jaz compiler const circuitDef = JSON.parse(fs.readFileSync("myCircuit.cir", "utf8"));

@@ -31,7 +31,7 @@ ```

### Inspect the circuit. -``` +```js // `signalId` can always be a number or an alias string circuit.nConstraints; // number of constraints

@@ -77,7 +77,7 @@ ```

### Trusted setup. -``` +```js const setup = zkSnark.setup(circuit); fs.writeFileSink("myCircuit.vk_proof", JSON.stringify(setup.vk_proof), "utf8"); fs.writeFileSink("myCircuit.vk_verifier", JSON.stringify(setup.vk_verifier), "utf8");

@@ -86,7 +86,7 @@ ```

### Generate proof. -``` +```js const circuitDef = JSON.parse(fs.readFileSync("myCircuit.cir", "utf8")); const circuit = new zkSnark.Circuit(circuitDef); const input = {

@@ -101,7 +101,7 @@ ```

### Verifier. -``` +```js const vk_verifier = JSON.parse(fs.readFileSync("myCircuit.vk_verifier", "utf8")); if (zkSnark.isValid(vk_verifier, proof, publicSignals)) {