Add Arbitrary dependency to units

Implement Arbitrary for a select subset of unit types.

Author: yancyribbens

Cargo-minimal.lock

@@ -8,6 +8,12 @@ version = "1.0.57"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "08f9b8508dccb7687a1d6c4ce66b2b0ecef467c94667de27d8d7fe1f8d2a9cdc"
 
+[[package]]
+name = "arbitrary"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c38b6b6b79f671c25e1a3e785b7b82d7562ffc9cd3efdc98627e5668a2472490"
+
 [[package]]
 name = "arrayvec"
 version = "0.7.4"
@@ -49,6 +55,7 @@ dependencies = [
 name = "bitcoin"
 version = "0.31.0"
 dependencies = [
+ "arbitrary",
  "base58ck",
  "base64",
  "bech32",
@@ -94,6 +101,7 @@ version = "0.1.2"
 name = "bitcoin-units"
 version = "0.1.2"
 dependencies = [
+ "arbitrary",
  "bitcoin-internals",
  "serde",
  "serde_json",

Cargo-recent.lock

@@ -8,6 +8,12 @@ version = "1.0.71"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9c7d0618f0e0b7e8ff11427422b64564d5fb0be1940354bfe2e0529b18a9d9b8"
 
+[[package]]
+name = "arbitrary"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c38b6b6b79f671c25e1a3e785b7b82d7562ffc9cd3efdc98627e5668a2472490"
+
 [[package]]
 name = "arrayvec"
 version = "0.7.4"
@@ -48,6 +54,7 @@ dependencies = [
 name = "bitcoin"
 version = "0.31.0"
 dependencies = [
+ "arbitrary",
  "base58ck",
  "base64",
  "bech32",
@@ -93,6 +100,7 @@ version = "0.1.2"
 name = "bitcoin-units"
 version = "0.1.2"
 dependencies = [
+ "arbitrary",
  "bitcoin-internals",
  "serde",
  "serde_json",

units/Cargo.toml

@@ -24,6 +24,7 @@ rustdoc-args = ["--cfg", "docsrs"]
 [dependencies]
 internals = { package = "bitcoin-internals", version = "0.3.0" }
 
+arbitrary = { version = "1", optional =true }
 serde = { version = "1.0.103", default-features = false, features = ["derive"], optional = true }
 
 [dev-dependencies]

units/contrib/test_vars.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 # Test all these features with "std" enabled.
-FEATURES_WITH_STD="serde"
+FEATURES_WITH_STD="serde arbitrary"
 
 # Test all these features without "std" enabled.
-FEATURES_WITHOUT_STD="alloc serde"
+FEATURES_WITHOUT_STD="alloc serde arbitrary"
 
 # Run and lint these examples.
 EXAMPLES=""

units/src/amount.rs

@@ -15,6 +15,8 @@ use core::{default, fmt, ops};
 
 #[cfg(feature = "serde")]
 use ::serde::{Deserialize, Serialize};
+#[cfg(feature = "arbitrary")]
+use arbitrary::{Arbitrary, Unstructured};
 use internals::error::InputString;
 use internals::write_err;
 
@@ -1876,6 +1878,14 @@ pub mod serde {
     }
 }
 
+#[cfg(feature = "arbitrary")]
+impl<'a> Arbitrary<'a> for Amount {
+    fn arbitrary(u: &mut Unstructured<'a>) -> arbitrary::Result<Self> {
+        let a = u64::arbitrary(u)?;
+        Ok(Amount(a))
+    }
+}
+
 #[cfg(kani)]
 mod verification {
     use std::cmp;

units/src/fee_rate.rs

@@ -5,6 +5,8 @@
 use core::fmt;
 use core::ops::{Div, Mul};
 
+#[cfg(feature = "arbitrary")]
+use arbitrary::{Arbitrary, Unstructured};
 #[cfg(feature = "serde")]
 use serde::{Deserialize, Serialize};
 
@@ -145,6 +147,14 @@ impl Div<Weight> for Amount {
 
 crate::impl_parse_str_from_int_infallible!(FeeRate, u64, from_sat_per_kwu);
 
+#[cfg(feature = "arbitrary")]
+impl<'a> Arbitrary<'a> for FeeRate {
+    fn arbitrary(u: &mut Unstructured<'a>) -> arbitrary::Result<Self> {
+        let f = u64::arbitrary(u)?;
+        Ok(FeeRate(f))
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;