Skip to content

A SNARK protocol over towers of binary fields, implemented in Rust (mirror of https://gitlab.com/IrreducibleOSS/binius)

License

Notifications You must be signed in to change notification settings

argumentcomputer/binius

 
 

Repository files navigation

Binius logo

Binius

Binius is a Rust library implementing a cryptographic succinct non-interactive argument of knowledge (SNARK) over towers of binary fields. The techniques are described formally in the papers Succinct Arguments over Towers of Binary Fields and Polylogarithmic Proofs for Multilinears over Binary Towers.

Comprehensive documentation is available at binius.xyz.

Usage

At this stage, the primary interfaces are the unit tests and benchmarks. The benchmarks use the criterion library.

To run the benchmarks, use the command cargo bench. To run the unit tests, use the command cargo test.

Binius implements optimizations for certain target architectures. To enable these, export the environment variable

RUSTFLAGS="-C target-cpu=native"

Binius has notable optimizations on Intel processors featuring the Galois Field New Instructions (GFNI) instruction set extension. To determine if your processor supports this feature, run

rustc --print cfg -C target-cpu=native | grep gfni

If the output of the command above is empty, the processor does not support these instructions.

When including binius as a dependency, it is recommended to add the following lines to your Cargo.toml file to have optimizations across crates

[profile.release]
lto = "fat"

Examples

There are examples of simple commit-and-prove SNARKs in the examples directory. For example, you may run

cargo run --release --example sha256_circuit

By default, all the examples are run on relatively small instance sizes. The examples accept command line arguments to specify the size of the data.

API Documentation

Rust API documentation is hosted at https://docs.binius.xyz/. The generated HTML pages include KaTeX so that LaTeX in Rust docs is rendered correctly.

To generate the documentation locally, run

cargo doc --no-deps

Support

This project is under active development. The developers will make breaking changes at will. Any modules that are stabilized will be explicitly documented as such.

We use GitLab's issue system for tracking bugs, features, and other development tasks.

This codebase certainly contains bugs at this point in its development. We discourage the use of this library for security-critical applications until future notice. Any bugs, including those affecting the security of the system, may be filed publicly as an issue.

Authors

Binius is developed by Irreducible.

License

Copyright 2023-2025 Irreducible Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

A SNARK protocol over towers of binary fields, implemented in Rust (mirror of https://gitlab.com/IrreducibleOSS/binius)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 99.9%
  • Other 0.1%