Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add supported features table #45

Merged
merged 1 commit into from
Apr 3, 2024
Merged

docs: add supported features table #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 32 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,37 @@

This library enables the creation of arithmetic circuits from circom programs.

## Features supported:
| | | | | |
|---|---|---|---|---|
| | | | | |
| | | | | |
| | | | | |

## circomlib supported/modified:
(We aim to support canonical circomlib.)

| | | | | |
|---|---|---|---|---|
| | | | | |
| | | | | |
| | | | | |

Other important components such as circomlib-ml reside under apps.
## Supported Circom Features

| Category | Type | Supported |
| --------------- | ------------------------ | :-------: |
| **Statements** | `InitializationBlock` | ✅ |
| | `Block` | ✅ |
| | `Substitution` | ✅ |
| | `Declaration` | ✅ |
| | `IfThenElse` | ✅ |
| | `While` | ✅ |
| | `Return` | ✅ |
| | `MultSubstitution` | ❌ |
| | `UnderscoreSubstitution` | ❌ |
| | `ConstraintEquality` | ❌ |
| | `LogCall` | ❌ |
| | `Assert` | ❌ |
| **Expressions** | `Call` | ✅ |
| | `InfixOp` | ✅ |
| | `Number` | ✅ |
| | `Variable` | ✅ |
| | `PrefixOp` | ❌ |
| | `InlineSwitchOp` | ❌ |
| | `ParallelOp` | ❌ |
| | `AnonymousComp` | ❌ |
| | `ArrayInLine` | ❌ |
| | `Tuple` | ❌ |
| | `UniformArray` | ❌ |

## Circomlib

WIP

## Requirements

Expand Down Expand Up @@ -66,6 +80,7 @@ To run the program with specific input file path and output directory path, use
```

## ZK/MPC/FHE backends:

- [2PC-GC with mpz-bmr16](https://github.com/tkmct/mpz/tree/bmr16)
- [MP-SPDZ MPC](https://github.com/mhchia/MP-SPDZ/tree/arith-executor)

Expand Down
Loading