Skip to content

Introduce Arbitrary crate and add PublicKey arbitrary impl #826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 21, 2025
Merged

Introduce Arbitrary crate and add PublicKey arbitrary impl #826

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Cargo-minimal.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -224,6 +230,7 @@ checksum = "ea6a9290e3c9cf0f18145ef7ffa62d68ee0bf5fcd651017e586dc7fd5da448c2"
name = "secp256k1"
version = "0.31.1"
dependencies = [
"arbitrary",
"bincode",
"bitcoin_hashes",
"getrandom",
Expand Down
7 changes: 7 additions & 0 deletions Cargo-recent.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -215,6 +221,7 @@ checksum = "e1cf6437eb19a8f4a6cc0f7dca544973b0b78843adbfeb3683d1a94a0024a294"
name = "secp256k1"
version = "0.31.1"
dependencies = [
"arbitrary",
"bincode",
"bitcoin_hashes",
"getrandom",
Expand Down
2 changes: 2 additions & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }
Expand Down
22 changes: 22 additions & 0 deletions src/key.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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 {
Expand Down
Loading