From 58dae52273aca8d13411c4aad75bddf950d3d360 Mon Sep 17 00:00:00 2001 From: Andrew Poelstra Date: Tue, 20 Oct 2026 12:03:47 +0000 Subject: [PATCH] Update README.md to indicate that repo is archived on Github --- README.md | 73 +------------------------------------------------------ 1 file changed, 1 insertion(+), 72 deletions(-) diff --git a/README.md b/README.md index bf7b68509..749a127a0 100644 --- a/README.md +++ b/README.md @@ -1,72 +1 @@ -
-

Rust Secp256k1

- -

- Crate Info - CC0 1.0 Universal Licensed - CI Status - API Docs - Rustc Version 1.63.0+ -

-
- -`rust-secp256k1` is a wrapper around [libsecp256k1](https://github.com/bitcoin-core/secp256k1), a C -library implementing various cryptographic functions using the [SECG](https://www.secg.org/) curve -[secp256k1](https://en.bitcoin.it/wiki/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` -* makes no allocations (except in unit tests) for efficiency and use in freestanding implementations - -### 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.63.0**. - -### 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. - -### Benchmarks - -We use a custom Rust compiler configuration conditional to guard the bench mark code. To run the -bench marks use: `RUSTFLAGS='--cfg=bench' cargo +nightly bench --features=recovery`. - -### A note on `non_secure_erase` - -This crate's secret types (`SecretKey`, `Keypair`, `SharedSecret`, `Scalar`, `DisplaySecret`, -`SessionSecretRand`, `SecretNonce`, and `ElligatorSwiftSharedSecret`) -have a method called `non_secure_erase` that *attempts* to overwrite the contained secret. This -method is provided to assist other libraries in building secure secret erasure. However, this -library makes no guarantees about the security of using `non_secure_erase`. In particular, -the compiler doesn't have any concept of secrets and in most cases can arbitrarily move or copy -values anywhere it pleases. For more information, consult the [`zeroize`](https://docs.rs/zeroize) -documentation. - -## 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 -`--cfg=secp256k1_fuzz` in your `RUSTFLAGS` variable. - -Note that `cargo hfuzz` does **not** set this config flag automatically. In 0.27.0 -and earlier versions, we used the `--cfg=fuzzing` which honggfuzz does set, but we -changed this because there was no way to override it. - +This repository is archived and has been moved to https://git.rust-bitcoin.org/rust-bitcoin/rust-secp256k1/