Skip to content

nucypher/ferveo

 
 

Repository files navigation

Ferveo

ci-badge

This project is under active development. For questions, please join us at Threshold Network Discord


A synchronous Distributed Key Generation protocol for front-running protection on public blockchains.

About

The distributed key generated by Ferveo can be input into a compatible threshold encryption/decryption or a threshold signature protocol. Ferveo distributes the shared private key by relative staking weight and relies on an underlying blockchain for synchonicity.

Security Warning

This library is under development and has not been reviewed, audited, or prepared for use.

Documentation

Documentation can be found here. It is recommended to use mdbook to render the docs. Run mdbook serve in the book folder.

A preprint paper describing the construction of Ferveo and the novel cryptosystems used is available at IACR.

Build

A Rust toolchain with version >= 1.67.0 is required. In the future, Ferveo will target the stable toolchain. Installation via rustup is recommended.

Run cargo build --release to build. Please note that performance may be significantly poorer when compiling in Debug mode.

Testing

Run cargo test --no-default-features --release to run tests. Please note that performance may be significantly poorer when testing in Debug mode.

Benchmarks

Run cargo bench --benches to run benchmarks. Benchmark report is available in the target/criterion/report folder.

Packages

No packages published

Languages

  • Rust 90.5%
  • Python 6.7%
  • TypeScript 1.6%
  • Other 1.2%