2018-08-28 15:03:42 -07:00
|
|
|
# pairing [![Crates.io](https://img.shields.io/crates/v/pairing.svg)](https://crates.io/crates/pairing) #
|
|
|
|
|
2019-09-24 02:53:52 -07:00
|
|
|
`pairing` is a crate for using pairing-friendly elliptic curves.
|
|
|
|
|
|
|
|
Currently, only the [BLS12-381](https://z.cash/blog/new-snark-curve.html)
|
|
|
|
construction is implemented.
|
|
|
|
|
|
|
|
## Roadmap
|
|
|
|
|
|
|
|
`pairing` is being refactored into a generic library for working with
|
|
|
|
pairing-friendly curves. After the refactor, `pairing` will provide basic traits
|
|
|
|
for pairing-friendly elliptic curve constructions, while specific curves will be
|
|
|
|
in separate crates.
|
2018-08-28 15:03:42 -07:00
|
|
|
|
|
|
|
## [Documentation](https://docs.rs/pairing/)
|
|
|
|
|
|
|
|
Bring the `pairing` crate into your project just as you normally would.
|
|
|
|
|
|
|
|
## Security Warnings
|
|
|
|
|
2019-09-24 02:53:52 -07:00
|
|
|
This library does not make any guarantees about constant-time operations, memory
|
|
|
|
access patterns, or resistance to side-channel attacks.
|
2018-08-28 15:03:42 -07:00
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
Licensed under either of
|
|
|
|
|
2019-09-24 02:53:52 -07:00
|
|
|
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0)
|
2018-08-28 15:03:42 -07:00
|
|
|
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
|
|
|
|
|
|
|
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.
|