Merge #826: Introduce Arbitrary crate and add PublicKey arbitrary impl

fa8af6e Introduce Arbitrary crate and add PublicKey impl (Shing Him Ng)

Pull request description:

  I was looking into writing some `Arbitrary` impls in the `bitcoin` crate, and one of the types contained a `PublicKey`. Any interest in adding the arbitrary feature here?


ACKs for top commit:
  apoelstra:
    ACK fa8af6e; successfully ran local tests; nice!


Tree-SHA512: cee541d209309e0629e6674523972a67cfc22026975349967fc8eb51b68eda134536956f29b31cfa3e89b04aff47e2544907a52947ff5e9eb53e477361776072

Author: apoelstra

Cargo-minimal.lock

@@ -2,6 +2,12 @@
 # It is not intended for manual editing.
 version = 3
 
+[[package]]
+name = "arbitrary"
+version = "1.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dde20b3d026af13f561bdd0f15edf01fc734f0dafcedbaf42bba506a9517f223"
+
 [[package]]
 name = "arrayvec"
 version = "0.7.6"
@@ -224,6 +230,7 @@ checksum = "ea6a9290e3c9cf0f18145ef7ffa62d68ee0bf5fcd651017e586dc7fd5da448c2"
 name = "secp256k1"
 version = "0.31.1"
 dependencies = [
+ "arbitrary",
  "bincode",
  "bitcoin_hashes",
  "getrandom",

Cargo-recent.lock

@@ -2,6 +2,12 @@
 # It is not intended for manual editing.
 version = 3
 
+[[package]]
+name = "arbitrary"
+version = "1.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dde20b3d026af13f561bdd0f15edf01fc734f0dafcedbaf42bba506a9517f223"
+
 [[package]]
 name = "arrayvec"
 version = "0.7.6"
@@ -215,6 +221,7 @@ checksum = "e1cf6437eb19a8f4a6cc0f7dca544973b0b78843adbfeb3683d1a94a0024a294"
 name = "secp256k1"
 version = "0.31.1"
 dependencies = [
+ "arbitrary",
  "bincode",
  "bitcoin_hashes",
  "getrandom",

Cargo.toml

@@ -32,10 +32,12 @@ global-context = ["std"]
 # if you are doing a no-std build, then this feature does nothing
 # and is not necessary.)
 global-context-less-secure = ["global-context"]
+arbitrary = ["dep:arbitrary"]
 
 [dependencies]
 secp256k1-sys = { version = "0.11.0", default-features = false, path = "./secp256k1-sys" }
 
+arbitrary = { version = "1.4", optional = true }
 hashes = { package = "bitcoin_hashes", version = "0.14", default-features = false, optional = true }
 rand = { version = "0.9", default-features = false, optional = true }
 serde = { version = "1.0.103", default-features = false, optional = true }

src/key.rs

@@ -6,6 +6,8 @@
 use core::ops::{self, BitXor};
 use core::{fmt, ptr, str};
 
+#[cfg(feature = "arbitrary")]
+use arbitrary::{Arbitrary, Unstructured};
 use secp256k1_sys::secp256k1_ec_pubkey_sort;
 #[cfg(feature = "serde")]
 use serde::ser::SerializeTuple;
@@ -1653,6 +1655,26 @@ impl<C: Verification> Secp256k1<C> {
     }
 }
 
+#[cfg(feature = "arbitrary")]
+impl<'a> Arbitrary<'a> for PublicKey {
+    fn arbitrary(u: &mut Unstructured<'a>) -> arbitrary::Result<Self> {
+        let mut bytes = [0u8; 33];
+        loop {
+            // Unstructured::fill_buffer pads the buffer with zeroes if it runs out of data
+            if u.len() < 33 {
+                return Err(arbitrary::Error::NotEnoughData);
+            }
+
+            bytes[0] = if u.arbitrary::<bool>()? { 0x02 } else { 0x03 };
+            u.fill_buffer(&mut bytes[1..])?;
+
+            if let Ok(pk) = PublicKey::from_slice(&bytes) {
+                return Ok(pk);
+            }
+        }
+    }
+}
+
 #[cfg(test)]
 #[allow(unused_imports)]
 mod test {