Merge #66: Various modernization/cleanups and release 0.9.0

0a5a7e2 release 0.9.0 (Andrew Poelstra)
8274b29 add a few missing #derives (Andrew Poelstra)
1241bc6 cargo fmt (Andrew Poelstra)
2c84bfa ci: update contrib/test.sh for recent changes (Andrew Poelstra)
a0b1a4f remove unused `unstable` feature and references to benchmarks (Andrew Poelstra)
9af7b52 rename `use-rand` feature to `rand`; remove unused `rand-core` dep (Andrew Poelstra)
b016592 rename `use-serde` feature to `serde` and `bitcoin-private` to `internals` (Andrew Poelstra)
1ddc43f docsrs: label feature-gated functions (Andrew Poelstra)

Pull request description:

  The main thing I need here is the `PartialOrd` impl on `Twek`, but this also addresses a bunch of other nits.

ACKs for top commit:
  sanket1729:
    utACK 0a5a7e2.

Tree-SHA512: 6111386c03c4b189aa7829de4b787c0a96c4ea48c9252c6e1829e569320426662e24b12f786b06b61bc949c1e52050afbdd24304814679258f37a33d78365f8f

Author: apoelstra

.github/workflows/rust.yml

@@ -22,10 +22,6 @@ jobs:
         env:
           DO_ASAN: true
         run: ./contrib/test.sh
-      - name: Running benchmarks
-        env:
-          DO_BENCH: true
-        run: ./contrib/test.sh
       - name: Building docs
         env:
           DO_DOCS: true

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Unreleased
 
+# 0.9.0 - 2023-06-08
+
+- Rename `use-serde` to `serde` and `use-rand` to `rand`
+- Remove unused `unstable` feature
+- Add `PartialOrd`, `Ord` and `Hash` back to `Tweak`
+
 # 0.8.0 - 2023-04-13
 
 - Increment MSRV to 1.48.0

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "secp256k1-zkp"
-version = "0.8.0"
+version = "0.9.0"
 authors = [ "Dawid Ciężarkiewicz <dpc@ucore.info>",
             "Andrew Poelstra <apoelstra@wpsoftware.net>",
             "Lucas Soriano <lucas@comit.network>",
@@ -16,35 +16,32 @@ edition = "2018"
 
 # Should make docs.rs show all functions, even those behind non-default features
 [package.metadata.docs.rs]
-features = [ "use-rand", "rand-std", "use-serde", "recovery" ]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
 
 [features]
-unstable = ["recovery", "rand-std"]
 default = ["std"]
 std = ["secp256k1-zkp-sys/std", "secp256k1/std"]
-rand-std = ["rand/std", "secp256k1/rand-std"]
+rand-std = ["actual-rand/std", "secp256k1/rand-std"]
 recovery = ["secp256k1-zkp-sys/recovery", "secp256k1/recovery"]
 lowmemory = ["secp256k1-zkp-sys/lowmemory", "secp256k1/lowmemory"]
 global-context = ["std", "rand-std", "secp256k1/global-context"]
 bitcoin_hashes = ["secp256k1/bitcoin_hashes"]
-use-serde = ["serde", "secp256k1/serde"]
-use-rand = ["rand", "secp256k1/rand"]
+serde = ["actual-serde", "secp256k1/serde"]
+rand = ["actual-rand", "secp256k1/rand"]
 
 [dependencies]
+actual-serde = { package = "serde", version = "1.0", default-features = false, optional = true }
+actual-rand = { package = "rand", version = "0.8", default-features = false, optional = true }
 secp256k1 = "0.27.0"
 secp256k1-zkp-sys = { version = "0.8.0", default-features = false, path = "./secp256k1-zkp-sys" }
-rand = { version = "0.8", default-features = false, optional = true }
-serde = { version = "1.0", default-features = false, optional = true }
-bitcoin-private = "0.1.0"
+internals = { package = "bitcoin-private", version = "0.1.0" }
 
 [dev-dependencies]
-rand = "0.8"
-rand_core = "0.6"
 serde_test = "1.0"
 
 [target.wasm32-unknown-unknown.dev-dependencies]
 wasm-bindgen-test = "0.3"
-rand = { version = "0.8" }
 getrandom = { version = "0.2", features = ["js"] }
 
 [lib]

README.md

@@ -1,6 +1,6 @@
 ![Continuous integration](https://github.com/ElementsProject/rust-secp256k1-zkp/workflows/Continuous%20integration/badge.svg)
 
-### rust-secp256k1-zkp
+# rust-secp256k1-zkp
 
 `rust-secp256k1-zkp` is a wrapper around [libsecp256k1-zkp](https://github.com/ElementsProject/secp256k1-zkp) that also
 re-exports all bindings from [`rust-secp256k1`](https://github.com/rust-bitcoin/rust-secp256k1).
@@ -13,11 +13,12 @@ In addition to everything from `rust-secp256k1`, this library adds type-safe Rus
 - pedersen commitments
 - adaptor signatures
 
-### Contributing
+# 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.41.1**.
+

contrib/test.sh

@@ -1,12 +1,6 @@
 #!/bin/sh -ex
 
-FEATURES="bitcoin_hashes global-context lowmemory use-rand rand-std recovery use-serde"
-
-# Use toolchain if explicitly specified
-if [ -n "$TOOLCHAIN" ]
-then
-    alias cargo="cargo +$TOOLCHAIN"
-fi
+FEATURES="bitcoin_hashes global-context lowmemory rand rand-std recovery serde"
 
 cargo --version
 rustc --version
@@ -34,15 +28,13 @@ if [ "$DO_FEATURE_MATRIX" = true ]; then
     done
 
     # Other combos
-    RUSTFLAGS='--cfg=rust_secp_fuzz' RUSTDOCFLAGS=$RUSTFLAGS cargo test --all
-    RUSTFLAGS='--cfg=rust_secp_fuzz' RUSTDOCFLAGS=$RUSTFLAGS cargo test --all --features="$FEATURES"
+    RUSTFLAGS='--cfg=rust_secp_fuzz' cargo test --all
+    RUSTFLAGS='--cfg=rust_secp_fuzz' cargo test --all --features="$FEATURES"
     cargo test --all --features="rand rand-std"
     cargo test --all --features="rand serde"
 
-    if [ "$DO_BENCH" = true ]; then  # proxy for us having a nightly compiler
-        cargo test --all --all-features
-        RUSTFLAGS='--cfg=rust_secp_fuzz' RUSTDOCFLAGS='--cfg=rust_secp_fuzz' cargo test --all --all-features
-    fi
+    cargo test --all --all-features
+    RUSTFLAGS='--cfg=rust_secp_fuzz' RUSTDOCFLAGS='--cfg=rust_secp_fuzz' cargo test --all --all-features
 fi
 
 # Docs
@@ -67,16 +59,10 @@ if [ "$DO_ASAN" = true ]; then
     cargo test --lib --all --features="$FEATURES" -Zbuild-std --target x86_64-unknown-linux-gnu
 fi
 
-# Bench
-if [ "$DO_BENCH" = true ]; then
-    cargo bench --all --features="unstable"
-fi
-
 # Lint if told to
 if [ "$DO_LINT" = true ]
 then
     (
-        rustup component add rustfmt
         cargo fmt --all -- --check
     )
 fi

src/lib.rs

@@ -29,9 +29,9 @@
 //!
 
 // Coding conventions
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![warn(missing_docs)]
 #![cfg_attr(all(not(test), not(feature = "std")), no_std)]
-#![cfg_attr(all(test, feature = "unstable"), feature(test))]
 
 /// Re-export of the internal FFI bindings crate
 pub extern crate secp256k1_zkp_sys;
@@ -42,20 +42,16 @@ extern crate secp256k1;
 
 #[cfg(feature = "bitcoin_hashes")]
 pub use secp256k1::hashes;
-#[cfg(any(test, feature = "std"))]
-extern crate core;
 /// Re-export of the `rand` crate
-#[cfg(any(test, feature = "rand"))]
-pub extern crate rand;
-#[cfg(test)]
-extern crate rand_core;
+#[cfg(feature = "actual-rand")]
+pub extern crate actual_rand as rand;
 /// Re-export of the `serde` crate
 #[cfg(feature = "serde")]
-pub extern crate serde;
+pub extern crate actual_serde as serde;
+#[cfg(any(test, feature = "std"))]
+extern crate core;
 #[cfg(all(test, feature = "serde"))]
 extern crate serde_test;
-#[cfg(all(test, feature = "unstable"))]
-extern crate test;
 #[cfg(all(test, target_arch = "wasm32"))]
 #[macro_use]
 extern crate wasm_bindgen_test;

src/zkp/ecdsa_adaptor.rs

@@ -8,15 +8,15 @@
 //!
 
 use crate::ffi::{self, CPtr, ECDSA_ADAPTOR_SIGNATURE_LENGTH};
+#[cfg(feature = "rand-std")]
+use crate::rand::thread_rng;
+#[cfg(feature = "actual-rand")]
+use crate::rand::{CryptoRng, Rng};
 use crate::{constants, PublicKey, Secp256k1, SecretKey};
 use crate::{ecdsa::Signature, Verification};
 use crate::{from_hex, Error};
 use crate::{Message, Signing};
 use core::{fmt, ptr, str};
-#[cfg(any(test, feature = "rand-std"))]
-use rand::thread_rng;
-#[cfg(any(test, feature = "rand"))]
-use rand::{CryptoRng, Rng};
 
 /// Represents an adaptor signature and dleq proof.
 #[derive(Debug, PartialEq, Clone, Copy, Eq)]
@@ -131,7 +131,7 @@ impl EcdsaAdaptorSignature {
     /// The nonce derivation process is strengthened against side channel
     /// attacks by providing auxiliary randomness using the ThreadRng random number generator.
     /// Requires compilation with "rand-std" feature.
-    #[cfg(any(test, feature = "rand-std"))]
+    #[cfg(feature = "rand-std")]
     pub fn encrypt<C: Signing>(
         secp: &Secp256k1<C>,
         msg: &Message,
@@ -147,7 +147,7 @@ impl EcdsaAdaptorSignature {
     /// The nonce derivation process is strengthened against side channel
     /// attacks by providing auxiliary randomness using the provided random number generator.
     /// Requires compilation with "rand" feature.
-    #[cfg(any(test, feature = "rand"))]
+    #[cfg(feature = "actual-rand")]
     pub fn encrypt_with_rng<C: Signing, R: Rng + CryptoRng>(
         secp: &Secp256k1<C>,
         msg: &Message,
@@ -291,9 +291,9 @@ impl EcdsaAdaptorSignature {
 mod tests {
     use super::Message;
     use super::*;
-    use crate::SECP256K1;
     #[cfg(not(rust_secp_fuzz))]
-    use rand::{rngs::ThreadRng, thread_rng, RngCore};
+    use crate::rand::{rngs::ThreadRng, thread_rng, RngCore};
+    use crate::SECP256K1;
 
     #[cfg(not(rust_secp_fuzz))]
     fn test_ecdsa_adaptor_signature_helper(

src/zkp/generator.rs

@@ -1,15 +1,15 @@
 use crate::ffi::{self, CPtr};
 use crate::{constants, from_hex, Error, Secp256k1, Signing, Tag};
 use core::{fmt, str};
-#[cfg(feature = "rand")]
+#[cfg(feature = "actual-rand")]
 use rand::Rng;
 
 /// Represents a blinding factor/Tweak on secp256k1 curve
 ///
 /// Contrary to a [`crate::SecretKey`], the value 0 is also a valid tweak.
 /// Values outside secp curve order are invalid tweaks.
 #[derive(Default, Copy, Clone)]
-#[cfg_attr(not(fuzzing), derive(Eq, PartialEq))]
+#[cfg_attr(not(fuzzing), derive(Eq, PartialEq, PartialOrd, Ord))]
 pub struct Tweak([u8; constants::SECRET_KEY_SIZE]);
 secp256k1_zkp_sys::impl_array_newtype!(Tweak, u8, constants::SECRET_KEY_SIZE);
 
@@ -56,7 +56,7 @@ impl str::FromStr for Tweak {
 
 impl Tweak {
     /// Generate a new random Tweak
-    #[cfg(feature = "rand")]
+    #[cfg(feature = "actual-rand")]
     pub fn new<R: Rng + ?Sized>(rng: &mut R) -> Tweak {
         let mut ret = [0u8; constants::SECRET_KEY_SIZE];
         rng.fill_bytes(&mut ret);
@@ -110,7 +110,7 @@ impl Tweak {
 /// Represents a generator on the secp256k1 curve.
 ///
 /// A generator is a public key internally but has a slightly different serialization with the first byte being tweaked.
-#[derive(Debug, Clone, Copy, Eq, Hash, PartialEq)]
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
 pub struct Generator(ffi::PublicKey);
 
 impl Generator {

src/zkp/rangeproof.rs

@@ -206,7 +206,7 @@ impl RangeProof {
 #[cfg(feature = "bitcoin_hashes")]
 impl ::core::fmt::Display for RangeProof {
     fn fmt(&self, f: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
-        use bitcoin_private::hex::display::DisplayHex;
+        use internals::hex::display::DisplayHex;
 
         write!(f, "{:x}", &self.serialize().as_slice().as_hex())
     }

src/zkp/surjection_proof.rs

@@ -11,7 +11,7 @@ pub struct SurjectionProof {
     inner: ffi::SurjectionProof,
 }
 
-#[cfg(feature = "rand")]
+#[cfg(feature = "actual-rand")]
 mod with_rand {
     use super::*;
     use crate::{Signing, Tag, Tweak};
@@ -193,7 +193,7 @@ impl SurjectionProof {
 #[cfg(feature = "bitcoin_hashes")]
 impl ::core::fmt::Display for SurjectionProof {
     fn fmt(&self, f: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
-        use bitcoin_private::hex::display::DisplayHex;
+        use internals::hex::display::DisplayHex;
 
         write!(f, "{:x}", &self.serialize().as_slice().as_hex())
     }