initial commit: open sourcing

Author: gbotrel

.circleci/config.yml

@@ -0,0 +1,21 @@
+version: 2.1
+jobs:
+  build:
+    docker:
+      - image: circleci/golang:latest
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - go-mod-v1-{{ checksum "go.sum" }}
+      - run: if [[ -n $(gofmt -l .) ]]; then echo "Please run gofmt"; exit 1; fi
+      - run: go vet -tags bls377 -v ./...
+      - run: go vet -tags bls381 -v ./...
+      - run: go vet -tags bn256 -v ./...
+      - run: go test -v -tags bls377,debug ./cs/... ./ecc/bls377/... .
+      - run: go test -v -tags bls381,debug ./cs/... ./ecc/bls381/... .
+      - run: go test -v -tags bn256,debug ./cs/... ./ecc/bn256/... .
+      - save_cache:
+          key: go-mod-v1-{{ checksum "go.sum" }}
+          paths:
+            - "/go/pkg/mod"

.gitignore

@@ -0,0 +1,37 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+old*.txt
+new*.txt
+*.prof
+*.pprof
+tasks.txt
+**/ref.txt
+*.pk
+*.vk
+*.proof
+*.input
+*.r1cs
+*.log
+
+# generated files during integratrion tests
+internal/tests/integration/
+
+# binary
+gnark
+playground
+
+.vscode
+
+# compiled sage -> python code
+*.sage.py

CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor gnark Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [[email protected]]. 
+All complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing to gnark
+
+### Table of Contents
+
+[Code of Conduct](#code-of-conduct)
+
+[How to Contribute](#how-to-contribute)
+
+* [Reporting Bugs](#reporting-bugs)
+* [Suggesting Enhancements](#suggesting-enhancements)
+* [Pull Requests](#pull-requests)
+
+
+
+## Code of Conduct
+* This project is governed by the [gnark Code of Conduct](CODE_OF_CONDUCT.md). By participating, 
+you are agreeing to uphold this code. Please report unacceptable behavior.
+## How to Contribute
+
+### Reporting Bugs
+#### Before Submitting A Bug 
+* Ensure the bug is not already reported by searching on GitHub under 
+[Issues](https://github.com/consensys/gnark/issues).
+#### How Do I Submit a (Good) Bug?
+* If you are unable to find an open issue addressing the problem, open a new one. Be sure to include a 
+**title and clear description**, as much relevant information as possible, and a **code sample** or 
+an **executable test case** demonstrating the unexpected behavior.
+* Describe the **exact steps** to **reproduce the problem** in as many details as possible. When 
+listing steps, don't just say what you did, but explain how you did it. For example, the exact 
+commands used in the terminal to start `gnark`. 
+* Provide **specific examples** to demonstrate the steps. Include links to files or GitHub projects, or 
+copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, 
+use [Markdown code blocks](https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github/).
+* Describe the **behavior you observed** after following the steps and explain the 
+problem with that behavior.
+* Explain the **behavior you expected** instead and why.
+* **Can you reliably reproduce the issue?** If not, provide details about how often the problem 
+happens and under which conditions it normally happens.
+
+### Suggesting Enhancements
+#### Before Submitting An Enhancement Suggestion
+* [Search](https://github.com/consensys/gnark/issues) to see if the enhancement has already been 
+suggested. If it has, add a comment to the existing issue instead of opening a new one.
+
+#### How Do I Submit A (Good) Enhancement Suggestion?
+Enhancement suggestions are tracked as GitHub issues. Create an issue on and provide 
+the following information:
+
+* Use a **clear and descriptive title** for the issue to identify the suggestion.
+* Provide a **step-by-step description** of the suggested enhancement in as much detail as possible.
+* Describe the **current behavior** and explain the **behavior you expect** instead and why.
+* Explain why this enhancement would be useful to other users.
+* Specify the **name and version of the OS** you're using.
+* Specify the **name and version of any relevant packages**.
+
+### Pull Requests
+There are a number of automated checks:
+* `go fmt`
+* `go vet`
+
+If these checks pass, pull requests will be reviewed by the project team against criteria including:
+* purpose - is this change useful
+* test coverage - are there unit/integration/acceptance tests demonstrating the change is effective
+* code consistency - naming, comments, design
+* changes that are solely formatting are likely to be rejected
+
+Always write a clear log message for your commits. One-line messages are fine for small changes, but 
+bigger changes should contain more detail.

Dockerfile.benchmark

@@ -0,0 +1,35 @@
+FROM golang:latest
+
+ENV GO111MODULE=on 
+
+WORKDIR /go/src/github.com/consensys/gnark
+
+COPY go.mod .
+COPY go.sum .
+RUN go mod download
+
+COPY . .
+
+# Build the application
+# RUN make
+
+WORKDIR /go/src/github.com/consensys/gnark/benchmark/benchmark
+RUN mkdir bls377 && mkdir bls381 && mkdir bn256
+RUN go build -tags bls377 -ldflags "-s -w"  -o ./bls377/benchmark
+RUN go build -tags bls381 -ldflags "-s -w"  -o ./bls381/benchmark
+RUN go build -tags bn256 -ldflags "-s -w"  -o ./bn256/benchmark
+
+WORKDIR /go/src/github.com/consensys/gnark/benchmark/benchmark/bls377
+RUN /go/src/github.com/consensys/gnark/benchmark/benchmark/bls377/benchmark generate
+
+WORKDIR /go/src/github.com/consensys/gnark/benchmark/benchmark/bls381
+RUN /go/src/github.com/consensys/gnark/benchmark/benchmark/bls381/benchmark generate
+
+WORKDIR /go/src/github.com/consensys/gnark/benchmark/benchmark/bn256
+RUN /go/src/github.com/consensys/gnark/benchmark/benchmark/bn256/benchmark generate
+
+WORKDIR /go/src/github.com/consensys/gnark/benchmark/benchmark
+
+CMD ["/bin/bash"]
+
+