Adding `decaf377` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add decaf377

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

decaf377 = "0.10.1"

The decaf377 library will be automatically available globally. Read the decaf377 library documentation.

Back to the crate overview.

Readme

decaf377

Many zero-knowledge protocols require a cryptographic group that can be used inside of an arithmetic circuit. This is accomplished by defining an “embedded” elliptic curve whose base field is the scalar field of the proving curve used by the proof system.

The Zexe paper, which defined BLS12-377, also defined (but did not name) a cofactor-4 Edwards curve defined over the BLS12-377 scalar field for exactly this purpose. However, non-prime-order groups are a leaky abstraction, forcing all downstream constructions to pay attention to correct handling of the cofactor. Although it is usually possible to do so safely, it requires additional care, and as discussed below, the optimal technique for handling the cofactor is different inside and outside of a circuit.

Instead, applying the Decaf construction to this curve gives decaf377, a clean abstraction that provides a prime-order group, complete with hash-to-group functionality, and works the same way inside and outside of a circuit.

More details are available on the Penumbra website.

Features

std: default, for use in std environments,
alloc: default, for use in alloc environments,
arkworks: default, uses Arkworks crates for elliptic curve operations,
u32_backend: uses 32-bit finite field arithmetic (default is 64-bit),
r1cs: enables rank-1 constraint system gadgets,
parallel: enables the use of parallelism.

Benchmarks

Run criterion benchmarks using:

cargo bench

This will generate a report at target/criterion/report/index.html.

Adding decaf377 library as a dependency

Adding `decaf377` library as a dependency