https://github.com/circify/circ

(Cir)cuit (C)ompiler. Compiling high-level languages to circuits for SMT, zero-knowledge proofs, and more.
https://github.com/circify/circ

Last synced: 13 days ago
JSON representation

(Cir)cuit (C)ompiler. Compiling high-level languages to circuits for SMT, zero-knowledge proofs, and more.

• Host: GitHub
• URL: https://github.com/circify/circ
• Owner: circify
• License: other
• Created: 2021-02-09T01:53:54.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-09-29T20:27:26.000Z (4 months ago)
• Last Synced: 2024-12-02T22:23:03.988Z (about 2 months ago)
• Language: Rust
• Homepage:
• Size: 12.1 MB
• Stars: 286
• Watchers: 15
• Forks: 41
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
# CirC: The Circuit Compiler

CirC is a *compiler infrastructure* which supports compilation from

high-level (stateful, uniform) languages to (state-free, non-uniform,

existentially quantified) circuits.

It's been used to compile {C, ZoKrates, Circom} to {SMT, ILP, R1CS,

MPC}, but it probably also applies to any statically type high-level

language and constant-time/FHE.

If you want to learn more about CirC, see our

[paper](https://circ.zk.fyi) or

[slides](https://cs.stanford.edu/~aozdemir/docs/circ.pdf).

## Requirements

Developing CirC requires the CVC4 SMT solver, which is used in some tests. Its

binary must be on your path. On Arch Linux and Ubuntu you can install the

`cvc4` package from official repositories.

You'll also need the COIN-OR CBC solver. On Arch linux, this is `coin-or-cbc`.

On Ubuntu `coinor-cbc` and `coinor-libcbc-dev`.

You'll also need a stable Rust compiler.

## Architecture

* Components:

  * `src/ir`

    * IR term definition

      * `term/bv.rs`: bit-vec literals

      * `term/field.rs`: prime-field literals

      * `term/ty.rs`: type-checking

      * `term/extras.rs`: algorithms: substitutions, etc.

    * Optimization

      * `opt/cfold.rs`: constant folding

      * `opt/flat.rs`: n-ary flattening

      * `opt/inline.rs`: inlining

      * `opt/sha.rs`: replacements for SHA's CH and MAJ operations

      * `opt/tuple.rs`: eliminating tuples

      * `opt/mem/obliv.rs`: oblivious array elimination

      * `opt/mem/lin.rs`: linear-scan array elimination

      * `opt/mem/visit.rs`: utility for visiting (and replacing?) all

         array-related terms

  * `src/target`

    * R1CS backend

      * lowering from IR

      * optimization

      * connection to bellman

    * SMT backend

      * based on rsmt2

  * `src/circify`

    * Machinery for recursive imports

    * `mem`: the stack memory module

    * `mod`: the main Circify interface

  * `src/front`

    * `zokrates`: the ZoKrates front-end

  * `src/util`

    * A once-queue (each item appears at most once)

      * Implemented by combining a set with a queue

    * hash-consing machinery

  * `examples/circ.rs`

    * This is the entry point to the zokrates copiler

## Backends

### SMT

The SMT backend can be changed between [CVC4](https://cvc4.github.io/)

and [cvc5](https://cvc5.github.io/) by setting the

[RSMT2_CVC4_CMD](https://docs.rs/rsmt2/latest/rsmt2/conf/constant.CVC4_ENV_VAR.html)

environmental variable to the SMT solver's invocation command (`cvc4` or

`cvc5`).