Merge pull request #601 from dark64/update-docs

Update book

zokrates_book/src/concepts/comments.md

@@ -1,7 +1,15 @@
 ## Comments
 
-Comments can be added with double-slashes.
+## Inline comments
+Inline (single-line) comments allow narrative on only one line at a time. Single-line comments can begin in any column of a given line and end at a new line or carriage return. Inline comments can be added with double-slashes.
 
 ```zokrates
 {{#include ../../../zokrates_cli/examples/book/comments.zok}}
+```
+
+## Multi-line comments
+Multi-line comments have one or more lines of narrative within a set of comment delimiters. The `/*` delimiter marks the beginning of the comment, and the `*/` marks the end. Any content between those delimiters is considered a comment.
+
+```zokrates
+{{#include ../../../zokrates_cli/examples/book/multiline_comments.zok}}
 ```

zokrates_book/src/reference/cli.md

@@ -59,7 +59,7 @@ zokrates setup
 
 Generates a trusted setup for the compiled program found at `./out`.
 
-Creates a proving key and a verifying key at `./proving.key` and `./verifying.key`.
+Creates a proving key and a verification key at `./proving.key` and `./verification.key`.
 These keys are derived from a source of randomness, commonly referred to as "toxic waste". Anyone having access to the source of randomness can produce fake proofs that will be accepted by a verifier following the protocol.
 
 The [proving scheme](proving_schemes.md) and curve can be chosen with the `proving-scheme` and `curve` flags.
@@ -70,7 +70,7 @@ The [proving scheme](proving_schemes.md) and curve can be chosen with the `provi
 zokrates export-verifier
 ```
 
-Using the verifying key at `./verifying.key`, generates a Solidity contract that contains the generated verification key and a public function to verify a solution to the compiled program at `./out`.
+Using the verification key at `./verification.key`, generates a Solidity contract that contains the generated verification key and a public function to verify a solution to the compiled program at `./out`.
 
 Creates a verifier contract at `./verifier.sol`.
 
@@ -84,22 +84,45 @@ Using the proving key at `./proving.key`, generates a proof for a computation of
 
 Returns the proof, for example:
 
-```k
-A = 0x45582d7906c967b1fd1cac0aad3efefa526e4cd888b8ecb5907b46c2eb1f781, 0x8158089a63a6aafa4afc3bbfd5ebf392e5ef61d0c5faf2e2445c9112450f29c
-A_p = 0x5e4fe0bfa79a571b8918138ee5d7b3d0ad394c9bb8f7d2e1549f7e3c3bab7e9, 0x1708b5ba3d138e433406c792f679ae6902fc9f7c6131305a9a5f826dbe2d71fb
-B = [0x34f5c5b7518597452e55a69bf9171a63837a98a1c1c1870b610b2cfe79c4573, 0x18e56afd179d67960db838a8fdb128eb78d5dd2c1ffcd564f9d0dada928ed71f], [0xf160ea8d2dc33b564a45c0998309b4bf5a050cc8f6288793b7401b37d1eb1a2, 0x23ade8ba2c64300b5ff90e18641516407054a21179829252fd87f1bd61a3be34]
-B_p = 0xc88b87d45f90da42b9c455da16dad76996ef5b1e859a4f0db7dcef4f7e3b2fd, 0x20ed7c62dd8c6c47506e6db1d4837daa42ae80b931227153054539dcbf6f3778
-C = 0x2c230cbffbcb6211d2cf8f434df291a413721e3bef5ada4030d532d14b6ea504, 0x21421565f75429d0922c8cf00b68e4da23c61670e787ce6a5de14a5a86ebdcb0
-C_p = 0xce11fe724ce1ce183c15c4f5405d9607d6c769422aa9f62f4868478324a2f5, 0x1e585b35ed22ef32fd70ef960818f1514d1dd94b3517c127e782de24173c69f9
-H = 0x2306e74a1a7e318d2d3c40cbea708b0e0b91cd1548c9db6261fc2bd815740978, 0xde538e4e99b0e20e84cdbbd3bc08c37bca0af21edd67faf52bc4027a9b00f7c
-K = 0x1868436121f271e9fbf78a8f75bb4077e2d4f208891793fd5b468afc3b05c0e4, 0x1021c3ecb15c3fd7340d4eb5bf446e1ad457020e4f8b7cc82f8af64507a35fbe
+```json
+{
+  "proof": {
+    "a": [
+      "0x1b1c65dfd2987bba07bb6b14c35f95afd41be7e4113873fde31de40a94a5fe55",
+      "0x10a9811ecc7b168d1fab0e806715d293c777aece4ff21d44300f2151e36b16e9"
+    ],
+    "b": [
+      [
+        "0x1ac6921597c999911bc8064722875bdfd2157f3d6278a1a12e1f4a27a063d173",
+        "0x24db42163adfb1d6212fff6b8a4e414aec35d239b54a7443df40d5226289fbf7"
+      ],
+      [
+        "0x1a2b44db88cd4d0dd069a0220ef39b6b540598d1f1849636cd266f15260f22d7",
+        "0x03f8bafc4b085bcb99779b6004836a047a496c5c2e0ae0bdc0e03f0552eefe07"
+      ]
+    ],
+    "c": [
+      "0x181adc5d5b5c4b4be2c44e49fb80f0ce209a2957d5d12f3b9e25a21121b677e3",
+      "0x0c0e936d36c812d03e86c1bb23f0c337aa0122fe1509050de2552216e77a9ec7"
+    ]
+  },
+  "inputs": [
+    "0x0000000000000000000000000000000000000000000000000000000000000003",
+    "0x0000000000000000000000000000000000000000000000000000000000000001"
+  ],
+  "raw": "..."
+}
 ```
 
-Passed to the verifier contract, this proof can be checked.
-For example, using `web3`, a call would look like the following:
+Passed to the verifier contract, this proof can be checked. See 
+[Verification](verification.md) section for more details.
 
-```k
-Verifier.at(<verifier contract address>).verifyTx(A, A_p, B, B_p, C, C_p, H, K, [...publicInputs, ...outputs])
+
+## `verify`
+
+```sh
+zokrates verify
 ```
 
-Where `A, ..., K` are defined as above (adding brackets and quotes: `A = ["0x123", "0x345"]`), `publicInputs` are the public inputs supplied to witness generation and `outputs` are the results of the computation.
+Natively verifies a given proof `./proof.json` with a given verification key `./verification.key`.
+The [proving scheme](proving_schemes.md) and curve can be set with the `proving-scheme` and `curve` flags, expecting the same combination as defined in the setup.

zokrates_book/src/reference/proving_schemes.md

@@ -26,6 +26,7 @@ When not using the default, the CLI flag has to be provided for the following co
 - `setup`
 - `export-verifier`
 - `generate-proof`
+- `verify`
 
 ## Supporting backends
 

zokrates_book/src/reference/verification.md

@@ -1,10 +1,18 @@
 # Verification
 
-Passed to the verifier contract, this proof can be checked.
+Passed to the verifier contract, a proof can be checked.
 For example, using `web3`, a call would look like the following:
 
-```
-Verifier.at(<verifier contract address>).verifyTx(A, A_p, B, B_p, C, C_p, H, K, [...publicInputs, ...outputs])
-```
+```javascript
+const accounts = await web3.eth.getAccounts();
+const address = '0x456...'; // verifier contract address
 
-Where `A, ..., K` are defined as above (adding brackets and quotes: `A = ["0x123", "0x345"]`), `publicInputs` are the public inputs supplied to witness generation and `outputs` are the results of the computation.
+let verifier = new web3.eth.Contract(abi, address, {
+    from: accounts[0], // default from address
+    gasPrice: '20000000000000'; // default gas price in wei
+});
+
+let result = await verifier.methods
+    .verifyTx(proof.proof, proof.inputs)
+    .call({ from: accounts[0] });
+```

zokrates_cli/examples/book/multiline_comments.zok

@@ -0,0 +1,6 @@
+/*
+    This is a multi-line comment
+    written in more than just one line.
+*/
+def main() -> (field):
+    return 42