milksad
/
rust-secp256k1-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity
rust-secp256k1-unsafe-fast/README.md

46 lines
2.0 KiB
Markdown
Raw Normal View History

Fix README links
2018-03-18 18:45:38 +00:00
[![Build Status](https://travis-ci.org/rust-bitcoin/rust-secp256k1.png?branch=master)](https://travis-ci.org/rust-bitcoin/rust-secp256k1)
Add Travis build status to README
2015-04-05 17:37:49 +00:00
bump version to 0.10.0; introduce CHANGELOG.md
2018-07-25 22:05:06 +00:00
[Full documentation](https://docs.rs/secp256k1/)
Increase heading size Currently the main heading of the readme uses a level three markdown heading, this is quite small. Use level two instead.
2022-07-13 04:34:16 +00:00
## rust-secp256k1
Add README
2015-04-04 17:30:07 +00:00
Fix link in README
2020-11-25 22:41:02 +00:00
`rust-secp256k1` is a wrapper around [libsecp256k1](https://github.com/bitcoin-core/secp256k1),
fix typos
2018-07-24 21:16:52 +00:00
a C library by Pieter Wuille for producing ECDSA signatures using the SECG curve
Add README
2015-04-04 17:30:07 +00: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`
Make note about non-allocations
2015-04-05 16:45:40 +00:00
* makes no allocations (except in unit tests) for efficiency and use in freestanding implementations
Add README
2015-04-04 17:30:07 +00:00
bump version to 0.10.0; introduce CHANGELOG.md
2018-07-25 22:05:06 +00: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.
Update MSRV in CI and Readme from 1.29 to 1.41
2021-09-14 15:46:20 +00:00
* This library should always compile with any combination of features on **Rust 1.41.1**.
replace `fuzztarget` Cargo feature with a rustc --cfg flag It's super dangerous to use Cargo features for this, since they can be set accidentally (or maliciously by any crate in a user's entire dep tree). Instead we can just require users set `RUSTFLAGS` appropriately, which we can easily do in our fuzzing scripts.
2020-12-22 15:42:02 +00:00
Add githooks Add `githooks` directory and: - Copy the default pre-commit hook into new githooks directory - Add a call to clippy to the pre-commit hook - Add a section to the README instructing devs how to use the new githooks
2022-06-10 02:58:39 +00:00
### Githooks
To assist devs in catching errors _before_ running CI we provide some githooks. If you do not
already have locally configured githooks you can use the ones in this repository by running, in the
root directory of the repository:
```
git config --local core.hooksPath githooks/
```
Alternatively add symlinks in your `.git/hooks` directory to any of the githooks we provide.
replace `fuzztarget` Cargo feature with a rustc --cfg flag It's super dangerous to use Cargo features for this, since they can be set accidentally (or maliciously by any crate in a user's entire dep tree). Instead we can just require users set `RUSTFLAGS` appropriately, which we can easily do in our fuzzing scripts.
2020-12-22 15:42:02 +00:00
## Fuzzing
If you want to fuzz this library, or any library which depends on it, you will
probably want to disable the actual cryptography, since fuzzers are unable to
forge signatures and therefore won't test many interesting codepaths. To instead
use a trivially-broken but fuzzer-accessible signature scheme, compile with
rename `rust_secp_fuzz` to `fuzzing`
2021-01-11 19:14:42 +00:00
`--cfg=fuzzing` in your `RUSTFLAGS` variable.
Note that `cargo hfuzz` sets this config flag automatically.
replace `fuzztarget` Cargo feature with a rustc --cfg flag It's super dangerous to use Cargo features for this, since they can be set accidentally (or maliciously by any crate in a user's entire dep tree). Instead we can just require users set `RUSTFLAGS` appropriately, which we can easily do in our fuzzing scripts.
2020-12-22 15:42:02 +00:00