Feature gate arbitrary crate in the consensus types crate (#7743)

Which issue # does this PR address?


  Puts the `arbitrary` crate behind a feature flag in the `types` crate.

Author: ec2

Cargo.lock

@@ -184,7 +184,7 @@ malloc_utils = { path = "common/malloc_utils" }
 maplit = "1"
 merkle_proof = { path = "consensus/merkle_proof" }
 metrics = { path = "common/metrics" }
-milhouse = "0.6"
+milhouse = { version = "0.7", default-features = false }
 mockall = "0.13"
 mockall_double = "0.3"
 mockito = "1.5.0"

Cargo.toml

@@ -1,4 +1,4 @@
-FROM rust:1.84.0-bullseye AS builder
+FROM rust:1.88.0-bullseye AS builder
 RUN apt-get update && apt-get -y upgrade && apt-get install -y cmake libclang-dev
 COPY . lighthouse
 ARG FEATURES

Dockerfile

@@ -9,18 +9,22 @@ default = ["sqlite", "legacy-arith"]
 # Allow saturating arithmetic on slots and epochs. Enabled by default, but deprecated.
 legacy-arith = []
 sqlite = ["dep:rusqlite"]
-# The `arbitrary-fuzz` feature is a no-op provided for backwards compatibility.
-# For simplicity `Arbitrary` is now derived regardless of the feature's presence.
-arbitrary-fuzz = []
+arbitrary = [
+    "dep:arbitrary",
+    "bls/arbitrary",
+    "ethereum_ssz/arbitrary",
+    "milhouse/arbitrary",
+    "ssz_types/arbitrary",
+    "swap_or_not_shuffle/arbitrary",
+]
+arbitrary-fuzz = ["arbitrary"]
 portable = ["bls/supranational-portable"]
 
 [dependencies]
 alloy-primitives = { workspace = true }
 alloy-rlp = { version = "0.3.4", features = ["derive"] }
-# The arbitrary dependency is enabled by default since Capella to avoid complexity introduced by
-# `AbstractExecPayload`
-arbitrary = { workspace = true, features = ["derive"] }
-bls = { workspace = true, features = ["arbitrary"] }
+arbitrary = { workspace = true, features = ["derive"], optional = true }
+bls = { workspace = true }
 compare_fields = { workspace = true }
 compare_fields_derive = { workspace = true }
 context_deserialize = { workspace = true }
@@ -29,7 +33,7 @@ derivative = { workspace = true }
 eth2_interop_keypairs = { path = "../../common/eth2_interop_keypairs" }
 ethereum_hashing = { workspace = true }
 ethereum_serde_utils = { workspace = true }
-ethereum_ssz = { workspace = true, features = ["arbitrary"] }
+ethereum_ssz = { workspace = true }
 ethereum_ssz_derive = { workspace = true }
 fixed_bytes = { workspace = true }
 hex = { workspace = true }
@@ -52,9 +56,9 @@ serde = { workspace = true, features = ["rc"] }
 serde_json = { workspace = true }
 serde_yaml = { workspace = true }
 smallvec = { workspace = true }
-ssz_types = { workspace = true, features = ["arbitrary"] }
+ssz_types = { workspace = true }
 superstruct = { workspace = true }
-swap_or_not_shuffle = { workspace = true, features = ["arbitrary"] }
+swap_or_not_shuffle = { workspace = true }
 tempfile = { workspace = true }
 test_random_derive = { path = "../../common/test_random_derive" }
 tracing = { workspace = true }

consensus/types/Cargo.toml

@@ -2,7 +2,8 @@ use crate::{ChainSpec, Epoch, Validator};
 use std::collections::BTreeSet;
 
 /// Activation queue computed during epoch processing for use in the *next* epoch.
-#[derive(Debug, PartialEq, Eq, Default, Clone, arbitrary::Arbitrary)]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[derive(Debug, PartialEq, Eq, Default, Clone)]
 pub struct ActivationQueue {
     /// Validators represented by `(activation_eligibility_epoch, index)` in sorted order.
     ///

consensus/types/src/activation_queue.rs

@@ -16,7 +16,6 @@ use tree_hash_derive::TreeHash;
     variants(Base, Electra),
     variant_attributes(
         derive(
-            arbitrary::Arbitrary,
             Debug,
             Clone,
             PartialEq,
@@ -29,23 +28,29 @@ use tree_hash_derive::TreeHash;
         ),
         context_deserialize(ForkName),
         serde(bound = "E: EthSpec"),
-        arbitrary(bound = "E: EthSpec"),
+        cfg_attr(
+            feature = "arbitrary",
+            derive(arbitrary::Arbitrary),
+            arbitrary(bound = "E: EthSpec"),
+        ),
     ),
     ref_attributes(
-        derive(Debug, PartialEq, TreeHash, Serialize,),
+        derive(Debug, PartialEq, TreeHash, Serialize),
         serde(untagged, bound = "E: EthSpec"),
         tree_hash(enum_behaviour = "transparent")
     ),
     map_ref_into(AttestationRef)
 )]
-#[derive(
-    arbitrary::Arbitrary, Debug, Clone, PartialEq, Serialize, Deserialize, Encode, TreeHash,
+#[cfg_attr(
+    feature = "arbitrary",
+    derive(arbitrary::Arbitrary),
+    arbitrary(bound = "E: EthSpec")
 )]
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Encode, TreeHash)]
 #[serde(untagged)]
 #[tree_hash(enum_behaviour = "transparent")]
 #[ssz(enum_behaviour = "transparent")]
 #[serde(bound = "E: EthSpec", deny_unknown_fields)]
-#[arbitrary(bound = "E: EthSpec")]
 pub struct AggregateAndProof<E: EthSpec> {
     /// The index of the validator that created the attestation.
     #[serde(with = "serde_utils::quoted_u64")]

consensus/types/src/aggregate_and_proof.rs

@@ -46,34 +46,31 @@ impl From<ssz_types::Error> for Error {
             Encode,
             TestRandom,
             Derivative,
-            arbitrary::Arbitrary,
             TreeHash,
         ),
         context_deserialize(ForkName),
         derivative(PartialEq, Hash(bound = "E: EthSpec")),
         serde(bound = "E: EthSpec", deny_unknown_fields),
-        arbitrary(bound = "E: EthSpec"),
+        cfg_attr(
+            feature = "arbitrary",
+            derive(arbitrary::Arbitrary),
+            arbitrary(bound = "E: EthSpec")
+        )
     ),
     ref_attributes(derive(TreeHash), tree_hash(enum_behaviour = "transparent")),
     cast_error(ty = "Error", expr = "Error::IncorrectStateVariant"),
     partial_getter_error(ty = "Error", expr = "Error::IncorrectStateVariant")
 )]
-#[derive(
-    Debug,
-    Clone,
-    Serialize,
-    TreeHash,
-    Encode,
-    Derivative,
-    Deserialize,
-    arbitrary::Arbitrary,
-    PartialEq,
+#[cfg_attr(
+    feature = "arbitrary",
+    derive(arbitrary::Arbitrary),
+    arbitrary(bound = "E: EthSpec")
 )]
+#[derive(Debug, Clone, Serialize, TreeHash, Encode, Derivative, Deserialize, PartialEq)]
 #[serde(untagged)]
 #[tree_hash(enum_behaviour = "transparent")]
 #[ssz(enum_behaviour = "transparent")]
 #[serde(bound = "E: EthSpec", deny_unknown_fields)]
-#[arbitrary(bound = "E: EthSpec")]
 pub struct Attestation<E: EthSpec> {
     #[superstruct(only(Base), partial_getter(rename = "aggregation_bits_base"))]
     pub aggregation_bits: BitList<E::MaxValidatorsPerCommittee>,
@@ -601,6 +598,7 @@ impl<'de, E: EthSpec> ContextDeserialize<'de, ForkName> for Vec<Attestation<E>>
 }
 */
 
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
 #[derive(
     Debug,
     Clone,
@@ -610,7 +608,6 @@ impl<'de, E: EthSpec> ContextDeserialize<'de, ForkName> for Vec<Attestation<E>>
     Encode,
     TestRandom,
     Derivative,
-    arbitrary::Arbitrary,
     TreeHash,
     PartialEq,
 )]

consensus/types/src/attestation.rs

@@ -9,8 +9,8 @@ use tree_hash_derive::TreeHash;
 /// The data upon which an attestation is based.
 ///
 /// Spec v0.12.1
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
 #[derive(
-    arbitrary::Arbitrary,
     Debug,
     Clone,
     PartialEq,

consensus/types/src/attestation_data.rs

@@ -1,7 +1,8 @@
 use crate::*;
 use serde::{Deserialize, Serialize};
 
-#[derive(arbitrary::Arbitrary, Debug, PartialEq, Clone, Copy, Default, Serialize, Deserialize)]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[derive(Debug, PartialEq, Clone, Copy, Default, Serialize, Deserialize)]
 pub struct AttestationDuty {
     /// The slot during which the attester must attest.
     pub slot: Slot,

consensus/types/src/attestation_duty.rs

@@ -25,21 +25,26 @@ use tree_hash_derive::TreeHash;
             Decode,
             TreeHash,
             TestRandom,
-            arbitrary::Arbitrary
         ),
         context_deserialize(ForkName),
         derivative(PartialEq, Eq, Hash(bound = "E: EthSpec")),
         serde(bound = "E: EthSpec"),
-        arbitrary(bound = "E: EthSpec")
+        cfg_attr(
+            feature = "arbitrary",
+            derive(arbitrary::Arbitrary),
+            arbitrary(bound = "E: EthSpec")
+        ),
     ),
     ref_attributes(derive(Debug))
 )]
-#[derive(
-    Debug, Clone, Serialize, Encode, Deserialize, TreeHash, Derivative, arbitrary::Arbitrary,
+#[cfg_attr(
+    feature = "arbitrary",
+    derive(arbitrary::Arbitrary),
+    arbitrary(bound = "E: EthSpec")
 )]
+#[derive(Debug, Clone, Serialize, Encode, Deserialize, TreeHash, Derivative)]
 #[derivative(PartialEq, Eq, Hash(bound = "E: EthSpec"))]
 #[serde(bound = "E: EthSpec", untagged)]
-#[arbitrary(bound = "E: EthSpec")]
 #[ssz(enum_behaviour = "transparent")]
 #[tree_hash(enum_behaviour = "transparent")]
 pub struct AttesterSlashing<E: EthSpec> {