Merge pull request #10 from QED-it/v1.1.0

Version 1.1.0, 2020-06, Simplifications

Changelog.md

@@ -0,0 +1,12 @@
+# Version 1.1.0, 2020-06, Simplifications
+
+Interface definition:
+- *(breaking)* Renamed R1CSContraints to ConstraintSystem.
+- *(breaking)* Moved r1cs_generation and witness_generation from Circuit to Command.
+- Added a dedicated Command message type to help with interoperable execution.
+- Added an example file in binary and JSON.
+
+Rust:
+- *(breaking)* Moved "writing" helpers to the "owned" modules.
+- Added "owned" versions of all message types.
+- Added a tool to convert to JSON.

README.md

@@ -56,6 +56,7 @@ See also the [WebAssembly modules](https://github.com/QED-it/zkinterface-wasm/)
 | ------------------------- | --------------------------- |
 | `zkInterface.pdf`         | The interface specification |
 | `zkinterface.fbs`         | The gadget interface definition using FlatBuffers |
+| `examples/`               | An example circuit in binary and JSON |
 | `rust/`                   | Cargo package `zkinterface`           |
 | `rust/src/zkinterface_generated.rs` | Generated Rust code         |
 | `rust/src/reading.rs`               | Rust helpers to read messages |

examples/example.json

@@ -0,0 +1,135 @@
+{
+  "circuits": [
+    {
+      "connections": {
+        "variable_ids": [
+          1,
+          2,
+          3
+        ],
+        "values": [
+          3,
+          0,
+          0,
+          0,
+          4,
+          0,
+          0,
+          0,
+          25,
+          0,
+          0,
+          0
+        ]
+      },
+      "free_variable_id": 6,
+      "field_maximum": null
+    }
+  ],
+  "constraint_systems": [
+    {
+      "constraints": [
+        {
+          "linear_combination_a": {
+            "variable_ids": [
+              1
+            ],
+            "values": [
+              1
+            ]
+          },
+          "linear_combination_b": {
+            "variable_ids": [
+              1
+            ],
+            "values": [
+              1
+            ]
+          },
+          "linear_combination_c": {
+            "variable_ids": [
+              4
+            ],
+            "values": [
+              1
+            ]
+          }
+        },
+        {
+          "linear_combination_a": {
+            "variable_ids": [
+              2
+            ],
+            "values": [
+              1
+            ]
+          },
+          "linear_combination_b": {
+            "variable_ids": [
+              2
+            ],
+            "values": [
+              1
+            ]
+          },
+          "linear_combination_c": {
+            "variable_ids": [
+              5
+            ],
+            "values": [
+              1
+            ]
+          }
+        },
+        {
+          "linear_combination_a": {
+            "variable_ids": [
+              0
+            ],
+            "values": [
+              1
+            ]
+          },
+          "linear_combination_b": {
+            "variable_ids": [
+              4,
+              5
+            ],
+            "values": [
+              1,
+              1
+            ]
+          },
+          "linear_combination_c": {
+            "variable_ids": [
+              3
+            ],
+            "values": [
+              1
+            ]
+          }
+        }
+      ]
+    }
+  ],
+  "witnesses": [
+    {
+      "assigned_variables": {
+        "variable_ids": [
+          4,
+          5
+        ],
+        "values": [
+          9,
+          0,
+          0,
+          0,
+          16,
+          0,
+          0,
+          0
+        ]
+      }
+    }
+  ]
+}