First commit

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# General Code
+* @reilabs/formal

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Found something wrong? Let us know.
+title: "[BUG] "
+labels: bug
+assignees: ''
+---
+
+# Describe the Bug
+
+A clear and concise description of what the bug is.
+
+# To Reproduce
+
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+# Expected Behaviour
+
+A clear and concise description of what you expected to happen.

.github/ISSUE_TEMPLATE/task.md

@@ -0,0 +1,15 @@
+---
+name: Task
+about: Something that needs doing.
+title: "[TASK] "
+labels: enhancement
+assignees: ''
+---
+
+# Description
+
+What is this about?
+
+# Spec
+
+Give details.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+# Summary
+
+<!-- What is this PR about? -->
+
+# Details
+
+<!-- What do you want the reviewers to focus on? Anything important that they should know? -->
+
+# Checklist
+
+- [ ] Documentation has been updated if necessary.

.github/workflows/build.yml

@@ -0,0 +1,30 @@
+name: Build
+on: push
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version-file: './go.mod'
+    - name: Go Format
+      run: gofmt -s -w . && git diff --exit-code
+    - name: Go Vet
+      run: go vet ./...
+    - name: Go Tidy
+      run: go mod tidy && git diff --exit-code
+    - name: Go Mod
+      run: go mod download
+    - name: Go Mod Verify
+      run: go mod verify
+    - name: Build
+      run: go build -v ./...
+    - name: Test
+      run: go test -v -count=1 -shuffle=on ./...

.gitignore

@@ -0,0 +1 @@
+.idea

CONTRIBUTING.md

@@ -0,0 +1,73 @@
+# Contributing
+
+This document exists as a brief introduction for how you can contribute to this
+repository. It includes a guide to
+[the structure of the repository](#repository-structure),
+[building](#building-and-testing) and
+[getting your code on `main`](#getting-your-code-on-main).
+
+If you are new to Go, there is a [guide](#new-to-go) to getting started with the
+language that provides some basic resources for getting started.
+
+> ## Font Display in Powershell
+>
+> If using Powershell, change font to `NSimSun` to be able to see all characters
+> properly. This is taken from
+> [this stackoverflow answer](https://stackoverflow.com/a/48029600).
+
+## Repository Structure
+
+This repository consists of two primary parts.
+
+- [`abstractor`](./abstractor): The abstractor, which is responsible for
+  providing an abstract front-end to various ZK systems.
+- [`extractor`](./extractor): The extractor, which is responsible for the generation
+  of the Lean code using the data generated by the parser in [gnark-lean-extractor](https://github.com/reilabs/gnark-lean-extractor). 
+
+## Building
+
+You can build and see the project in action as follows.
+
+1. Clone the repository into a location of your choice.
+
+```sh
+git clone https://github.com/reilabs/gnark-lean-demo
+```
+
+2. Build the go circuit project using `go` (meaning that you will need to have
+   that toolchain set up).
+
+```sh
+cd gnark-lean-demo
+go mod download
+go build -o gnark-lean-demo -v ./...
+./gnark-lean-demo extract-circuit --out=lean-circuit/LeanCircuit.lean
+```
+
+The Lean code will be printed in the file `lean-circuit/LeanCircuit.lean`
+
+## Getting Your Code on `main`
+
+This repository works on a fork and
+[pull request](https://github.com/reilabs/gnark-lean-demo/pulls) workflow, with
+code review and CI as an integral part of the process. This works as follows:
+
+1. If necessary, you fork the repository, but if you have access to do so please
+   create a branch.
+2. You make your changes on that branch.
+3. Pull request that branch against main.
+4. The pull request will be reviewed and CI will be run on it.
+5. Once the reviewer(s) have accepted the code and CI has passed, the code will
+   be merged to `main`.
+
+## New to Go?
+
+If you are new to working with [Go](https://go.dev), a great place to start is
+the official set of [tutorials](https://go.dev/learn/). They explain how to
+[install](https://go.dev/doc/install) and set the language up, as well as an
+[interactive tour](https://go.dev/tour/welcome/1) of how to use the language.
+
+We recommend being familiar with the language and the `go` command-line
+interface to the build system and compiler before interacting with the Go
+portion of this repository.
+

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 Reilabs Sp. z o.o.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,25 @@
+<a href="https://reilabs.io">
+<picture>
+  <source width="150" media="(prefers-color-scheme: dark)" srcset="https://github.com/reilabs/gnark-lean-extractor/assets/35899/c04bdb7f-4c31-4264-acb6-a96f32c6cc29">
+  <source width="150" media="(prefers-color-scheme: light)" srcset="https://github.com/reilabs/gnark-lean-extractor/assets/35899/fc11280b-e3e5-4a6f-83da-788884083c36">
+  <img width="150" src="https://github.com/reilabs/gnark-lean-extractor/assets/35899/fc11280b-e3e5-4a6f-83da-788884083c36">
+</picture>
+</a>
+
+# Lean Circuit Compiler
+
+This repository contains a Go library that transpiles
+[zero-knowledge](https://en.wikipedia.org/wiki/Zero-knowledge_proof) (ZK)
+circuits from [Go](https://go.dev) to [Lean](https://leanprover.github.io). In
+particular, it deals with circuits constructed as part of the
+[gnark](https://github.com/ConsenSys/gnark) proof system.
+
+This makes it possible to take existing gnark circuits and export them to Lean
+for later formal verification.
+
+This library contains the core of the extractor to be used in conjunction with [gnark-lean-extractor](https://github.com/reilabs/gnark-lean-extractor)
+which is the interface layer with [gnark](https://github.com/ConsenSys/gnark).
+
+For an overview of how to use this library, see the documentation in [gnark-lean-extractor](https://github.com/reilabs/gnark-lean-extractor).
+If you are interested in contributing, or are new to Go, please see our
+[contributing guidelines](./CONTRIBUTING.md) for more information.