ff_wasm_unknown_unknown

Crates.ioff_wasm_unknown_unknown
lib.rsff_wasm_unknown_unknown
version0.12.2
sourcesrc
created_at2022-12-01 19:15:16.874525
updated_at2022-12-01 20:07:15.155861
descriptionIndependent adaptation of the open-sourced ff library that removes features incompatible with wasm32-unknown-unknown architecture
homepagehttps://github.com/zkcrypto/ff
repositoryhttps://github.com/hideyour-cash/monorepo/packages/contract-libraries/ff_wasm_unknown_unknown
max_upload_size
id727855
size37,530
João Veiga (veigajoao)

documentation

https://docs.rs/ff/

README

ff_wasm_unknown_unknown

ff_wasm_unknown_unknown is an independent adaptation of the open-sourced ff library that removes features incompatible with wasm32-unknown-unknown architecture, specially methods that require pseudorandom number generation.

ff

ff is a finite field library written in pure Rust, with no unsafe{} code.

Disclaimers

  • This library does not provide constant-time guarantees. The traits enable downstream users to expose constant-time logic, but #[derive(PrimeField)] in particular does not generate constant-time code (even for trait methods that return constant-time-compatible values).

Usage

Add the ff crate to your Cargo.toml:

[dependencies]
ff = "0.12"

The ff crate contains the Field and PrimeField 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]
ff = { version = "0.12", features = ["derive"] }

And then use the macro like so:

#[macro_use]
extern crate ff;

#[derive(PrimeField)]
#[PrimeFieldModulus = "52435875175126190479447740508185965837690552500527637822603658699938581184513"]
#[PrimeFieldGenerator = "7"]
#[PrimeFieldReprEndianness = "little"]
struct Fp([u64; 4]);

And that's it! Fp now implements Field and PrimeField.

Minimum Supported Rust Version

Requires Rust 1.56 or higher.

Minimum supported Rust version can be changed in the future, but it will be done with a minor version bump.

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.

Commit count: 653

cargo fmt