rust-secp256k1/README.md

25 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2018-03-18 11:45:38 -07:00
[![Build Status](https://travis-ci.org/rust-bitcoin/rust-secp256k1.png?branch=master)](https://travis-ci.org/rust-bitcoin/rust-secp256k1)
2015-04-05 10:37:49 -07:00
[Full documentation](https://docs.rs/secp256k1/)
2015-04-04 10:30:07 -07:00
### rust-secp256k1
2018-03-18 11:45:38 -07:00
`rust-secp256k1` is a wrapper around ![libsecp256k1](https://github.com/bitcoin-core/secp256k1),
2018-07-24 14:16:52 -07:00
a C library by Pieter Wuille for producing ECDSA signatures using the SECG curve
2015-04-04 10:30:07 -07:00
`secp256k1`. This library
* exposes type-safe Rust bindings for all `libsecp256k1` functions
* implements key generation
* implements deterministic nonce generation via RFC6979
* implements many unit tests, adding to those already present in `libsecp256k1`
2015-04-05 09:45:40 -07:00
* makes no allocations (except in unit tests) for efficiency and use in freestanding implementations
2015-04-04 10:30:07 -07:00
### Contributing
Contributions to this library are welcome. A few guidelines:
* Any breaking changes must have an accompanied entry in CHANGELOG.md
* No new dependencies, please.
* No crypto should be implemented in Rust, with the possible exception of hash functions. Cryptographic contributions should be directed upstream to libsecp256k1.
* This library should always compile with any combination of features on **Rust 1.14**, which is the currently shipping compiler on Debian.
2015-04-04 13:51:06 -07:00