Skip to content

Latest commit

 

History

History
118 lines (80 loc) · 4.43 KB

README.md

File metadata and controls

118 lines (80 loc) · 4.43 KB
Raw

Circom-tfhe-rs

Circom-tfhe-rs allows user to perform TFHE arithmetizations by writing Circom code using the zama's tfhe-rs framework. Circom code is compiled into an arithmetic circuit using circom-2-arithc and then translated gate by gate to the corresponding tfhe-rs operators.

NOTE: Now circom-2-arithc also conveniently outputs the Bristol format with corresponding circuit_info (hence the json_arbistol is not necessary anymore).

Supported Circom Type and Op

Type Op Supported
Int (sint, cint) + Addition ✅
/ Division ✅
== Equality ✅
> Greater Than ✅
>= Greater Than or Equal ✅
< Less Than ✅
<= Less Than or Equal ✅
* Multiplication ✅
!= Not Equal ✅
- Subtraction ✅
** Exponentiation ❌
<< Shift Left ✅
>> Shift Right ✅
^ Bitwise XOR ✅
| Bitwise OR ✅
& Bitwise AND ✅
% Modulo ✅

Structure

  • circom-2-arithc - we are using the latest version.
  • tfhe-rs - supports the arithmetization on tfhe
  • main.py - the main script to run the circom-tfhe. It does the following:
    • Compiles the Circom code to the arithmetic circuit with circom-2-arithc.
    • Generates tfhe-rs program by converting bristol fashion circuit.
    • Performs the computation using tfhe-rs.
  • examples - example circuits to run with circom-tfhe.

Installation

Clone the repo

git clone https://github.com/Vishalkulkarni45/circom-tfhe-rs
git clone https://github.com/namnc/circom-2-arithc

Build circom-2-arithc

Go to the circom-2-arithc submodule directory:

cd circom-2-arithc

Initialize the .env file:

touch .env
vim .env

Build the compiler:

cargo build --release

How to run

We have two examples available:

In both examples, you will find the following files in each example directory:

  • circuit.circom - the circom code representing the circuit
  • {circuit_name}.py - automated generator for input files and raw_circuit tfhe-rs program

You can run these examples by following the instructions in the root directory.

# Go back to the root directory of circom-tfhe-rs
cd ../circom-tfhe-rs
mkdir outputs
python main.py {circuit_name}
  • {circuit_name} is the name of the circuit you want to run. Can either be ops_tests or naive_search.
  • Intermediate files will be stored in the outputs/{circuit_name} directory.
  • Outputs are directly printed to the console.

How it works

  1. Generate Rust directory in the outputs folder; outputs/{circuit_name} and outputs/{circuit_name}_raw

    • If the directory exists, it deletes the directory and makes new directory.

  2. Add the necessary dependencies in Cargo.toml in each Rust directory.

  3. For existing circom circuit, run circom-2-arithc.

  4. Run python script in examples/{circuit_name}/

    • It generates raw_circuit tfhe-rs code, input.json
    • After generating input.json, make a new file input_struct.json which has different format.
    • After generating raw_circuit tfhe-rs code, copy it into outputs/{circuit_name}_raw
    • Copy input.json and input_struct.json in outputs/{circuit_name} and outputs/{circuit_name}_raw

  5. Using bristol fashion circuit, generate tfhe-rs code.

  6. Run converted tfhe-rs code, and compare it with model tfhe-rs code.