Skip to content

Commit

Permalink
Merge remote-tracking branch 'parser-attestor/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
lonerapier committed Oct 28, 2024
2 parents 9812bcc + 5fd9651 commit 1ff48a4
Show file tree
Hide file tree
Showing 100 changed files with 11,983 additions and 103 deletions.
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/bounty.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: Bounty
about: Create a bounty for contributors
title: ''
labels: 'bounty'
assignees: ''

---

**Bounty description**

A clear and concise description of the project; should be accessible to a contributor with minimal context.

**Implementation requirements**

A clear and comprehensive list of the requirements for the bounty to be considered complete.

- [ ] Task 1
- Subtasks (if relevant)
- [ ] Task 2
- Subtasks (if relevant)
- [ ] Task 3
- Subtasks (if relevant)

**Bonus features**

Any additional features that will enhance the value of the bounty.

- [ ] Bonus Feature 1
- [ ] Bonus Feature 2

**Resources**

A list of potentially-useful resources. This list should be less than 5 total resources.

**Criteria**

For timely submissions of bounties that meet the implementation requirements, a bounty of at least $250 will be awarded to the contributor. Additional bounty amounts are available and will be rewarded based on the following criteria:

1. Completion of any of the bonus features listed above and/or other bonus features that improve the quality of the submission.
2. Correctness and security: A thorough review of the implementation should convince our team that they are correct and secure, with all requirements met.
3. Code clarity and quality: Succinct, easy-to-follow code with appropriate naming conventions. Utilize Rust’s type system for flexibility and security (e.g., compile-time checks where possible), and avoid external crates. Optimizations should be a lower priority than clarity, but can be included behind a feature flag as a bonus.
4. Documentation quality: Provide comprehensive README’s, Cargo docs, and inline comments where code itself is not self-explanatory. Prioritize clarity and readability.
40 changes: 40 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: lint

on:
pull_request:
types: [opened, synchronize, reopened]
push:
branches: [main]

jobs:
fmt:
name: fmt
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Install Rust
uses: dtolnay/rust-toolchain@master
with:
toolchain: nightly-2024-06-10
components: rustfmt

- name: cargo fmt
run: cargo fmt --all -- --check

clippy:
name: clippy
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Install Rust
uses: dtolnay/rust-toolchain@master
with:
toolchain: nightly-2024-06-10
components: clippy

- name: cargo clippy
run: cargo clippy --all
49 changes: 49 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: circom

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

jobs:
circom:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: '20'

- name: Install dependencies
run: |
npm install
npm install -g snarkjs
- name: Download and install Circom
run: |
CIRCOM_VERSION=2.1.9
curl -L https://github.com/iden3/circom/releases/download/v$CIRCOM_VERSION/circom-linux-amd64 -o circom
chmod +x circom
sudo mv circom /usr/local/bin/
circom --version
- name: Run tests
run: npm run test
rust:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Install Rust
uses: dtolnay/rust-toolchain@master
with:
toolchain: nightly-2024-06-10

- name: Run tests
run: cargo test --all
20 changes: 18 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
*.r1cs
/target

node_modules/*

# Circomkit generated
build/*
ptau/*
circuits/test/*.circom
circuits/main/*

# Rust generated
inputs/**/*.json
!inputs/search/witness.json

# Circom-witnesscalc generated
ir_log/*
log_input_signals.txt
*.bin
node_modules/*
*.r1cs
9 changes: 9 additions & 0 deletions .mocharc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"extension": [
"ts"
],
"require": "ts-node/register",
"spec": "circuits/test/**/*.test.ts",
"timeout": 100000,
"exit": true
}
Loading

0 comments on commit 1ff48a4

Please sign in to comment.