#prime-field #procedural #proc-macro #derive #finite-fields #build #fff

macro fff_derive

Procedural macro library used to build custom prime field implementations

4 releases

0.3.0 Jun 1, 2021
0.2.2 Apr 11, 2020
0.2.1 Feb 10, 2020
0.2.0 Feb 6, 2020

#27 in #prime-field

Download history 59/week @ 2023-11-26 37/week @ 2023-12-03 63/week @ 2023-12-10 70/week @ 2023-12-17 47/week @ 2023-12-24 15/week @ 2023-12-31 79/week @ 2024-01-07 75/week @ 2024-01-14 43/week @ 2024-01-21 28/week @ 2024-01-28 45/week @ 2024-02-04 47/week @ 2024-02-11 113/week @ 2024-02-18 99/week @ 2024-02-25 75/week @ 2024-03-03 65/week @ 2024-03-10

362 downloads per month
Used in 15 crates (via fff)

MIT/Apache

41KB
985 lines

fff

Fork of the great ff library.

fff is a finite field library written in Rust.

Disclaimers

  • This library does not provide constant-time guarantees.

The fff crate contains Field, PrimeField, PrimeFieldRepr and SqrtField traits. See the documentation for more.

#![derive(PrimeField)]

If you need an implementation of a prime field, this library also provides a procedural macro that will expand into an efficient implementation of a prime field when supplied with the modulus. PrimeFieldGenerator must be an element of Fp of p-1 order, that is also quadratic nonresidue.

First, enable the derive crate feature:

[dependencies]
fff = { version = "0.2", features = ["derive"] }

And then use the macro like so:

extern crate rand;
#[macro_use]
extern crate fff;

#[derive(PrimeField)]
#[PrimeFieldModulus = "52435875175126190479447740508185965837690552500527637822603658699938581184513"]
#[PrimeFieldGenerator = "7"]
struct Fp(FpRepr);

And that's it! Fp now implements Field and PrimeField. Fp will also implement SqrtField if supported. The library implements FpRepr itself and derives PrimeFieldRepr for it.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~2MB
~44K SLoC