Arbitrary trait for eth2/types (#1040)

* Add the arbitrary type to eth2/types and their deps

Signed-off-by: Kirk Baird <[email protected]>

* Wrap arbitrary in a feature flag

Signed-off-by: Kirk Baird <[email protected]>

* Fix feature for types

Signed-off-by: Kirk Baird <[email protected]>

* Fix comment

Signed-off-by: Kirk Baird <[email protected]>

* Patch versioning

Signed-off-by: Kirk Baird <[email protected]>

* Allow expanded crate reference for arbitrary 0.4.3

Signed-off-by: Kirk Baird <[email protected]>

* Add arbitrary to remaining types

Signed-off-by: Kirk Baird <[email protected]>

* use cmp::min

Signed-off-by: Kirk Baird <[email protected]>

* Derive Arbitrary trait for ValidatorStatus, TotalBalances and InclusionInfo

* Add CI check for state processing arbitrary faetures

Signed-off-by: Kirk Baird <[email protected]>

* Fix indentation

Signed-off-by: Kirk Baird <[email protected]>

Co-authored-by: Mehdi Zerouali <[email protected]>

Author: kirk-baird

.github/workflows/test-suite.yml

@@ -81,3 +81,10 @@ jobs:
     - uses: actions/checkout@v1
     - name: Lint code for quality and style with Clippy
       run: make lint
+  arbitrary-check:
+   runs-on: ubuntu-latest
+   needs: cargo-fmt
+   steps:
+   - uses: actions/checkout@v1
+   - name: Validate state_processing feature arbitrary-fuzz
+     run:  make arbitrary-fuzz

Cargo.lock

@@ -60,3 +60,4 @@ eth2_ssz = { path = "eth2/utils/ssz" }
 eth2_ssz_derive = { path = "eth2/utils/ssz_derive" }
 eth2_ssz_types = { path = "eth2/utils/ssz_types" }
 eth2_hashing = { path = "eth2/utils/eth2_hashing" }
+web3 = { git = "https://github.com/tomusdrw/rust-web3" }

Cargo.toml

@@ -58,6 +58,10 @@ lint:
 make-ef-tests:
 	make -C $(EF_TESTS)
 
+# Verifies that state_processing feature arbitrary-fuzz will compile
+arbitrary-fuzz:
+	cargo check --manifest-path=eth2/state_processing/Cargo.toml --features arbitrary-fuzz
+
 # Performs a `cargo` clean and cleans the `ef_tests` directory.
 clean:
 	cargo clean

Makefile

@@ -34,6 +34,16 @@ types = { path = "../types" }
 rayon = "1.2.0"
 eth2_hashing = { path = "../utils/eth2_hashing" }
 int_to_bytes = { path = "../utils/int_to_bytes" }
+arbitrary = { version = "0.4.3", features = ["derive"], optional = true }
 
 [features]
 fake_crypto = ["bls/fake_crypto"]
+arbitrary-fuzz = [
+  "arbitrary",
+  "types/arbitrary-fuzz",
+  "bls/arbitrary",
+  "merkle_proof/arbitrary",
+  "eth2_ssz/arbitrary",
+  "eth2_ssz_types/arbitrary",
+  "tree_hash/arbitrary",
+]

eth2/state_processing/Cargo.toml

@@ -33,7 +33,11 @@ mod verify_deposit;
 mod verify_exit;
 mod verify_proposer_slashing;
 
+#[cfg(feature = "arbitrary-fuzz")]
+use arbitrary::Arbitrary;
+
 /// The strategy to be used when validating the block's signatures.
+#[cfg_attr(feature = "arbitrary-fuzz", derive(Arbitrary))]
 #[derive(PartialEq, Clone, Copy)]
 pub enum BlockSignatureStrategy {
     /// Do not validate any signature. Use with caution.
@@ -45,6 +49,7 @@ pub enum BlockSignatureStrategy {
 }
 
 /// The strategy to be used when validating the block's signatures.
+#[cfg_attr(feature = "arbitrary-fuzz", derive(Arbitrary))]
 #[derive(PartialEq, Clone, Copy)]
 pub enum VerifySignatures {
     /// Validate all signatures encountered.

eth2/state_processing/src/per_block_processing.rs

@@ -2,6 +2,9 @@ use crate::common::get_attesting_indices;
 use safe_arith::SafeArith;
 use types::*;
 
+#[cfg(feature = "arbitrary-fuzz")]
+use arbitrary::Arbitrary;
+
 /// Sets the boolean `var` on `self` to be true if it is true on `other`. Otherwise leaves `self`
 /// as is.
 macro_rules! set_self_if_other_is_true {
@@ -13,6 +16,7 @@ macro_rules! set_self_if_other_is_true {
 }
 
 /// The information required to reward a block producer for including an attestation in a block.
+#[cfg_attr(feature = "arbitrary-fuzz", derive(Arbitrary))]
 #[derive(Debug, Clone, Copy)]
 pub struct InclusionInfo {
     /// The distance between the attestation slot and the slot that attestation was included in a
@@ -44,6 +48,7 @@ impl InclusionInfo {
 }
 
 /// Information required to reward some validator during the current and previous epoch.
+#[cfg_attr(feature = "arbitrary-fuzz", derive(Arbitrary))]
 #[derive(Debug, Default, Clone)]
 pub struct ValidatorStatus {
     /// True if the validator has been slashed, ever.
@@ -108,7 +113,9 @@ impl ValidatorStatus {
 
 /// The total effective balances for different sets of validators during the previous and current
 /// epochs.
+
 #[derive(Clone, Debug)]
+#[cfg_attr(feature = "arbitrary-fuzz", derive(Arbitrary))]
 pub struct TotalBalances {
     /// The effective balance increment from the spec.
     effective_balance_increment: u64,
@@ -165,6 +172,7 @@ impl TotalBalances {
 
 /// Summarised information about validator participation in the _previous and _current_ epochs of
 /// some `BeaconState`.
+#[cfg_attr(feature = "arbitrary-fuzz", derive(Arbitrary))]
 #[derive(Debug, Clone)]
 pub struct ValidatorStatuses {
     /// Information about each individual validator from the state's validator registry.

eth2/state_processing/src/per_epoch_processing/validator_statuses.rs

@@ -15,7 +15,7 @@ compare_fields_derive = { path = "../utils/compare_fields_derive" }
 dirs = "2.0.2"
 derivative = "1.0.3"
 eth2_interop_keypairs = { path = "../utils/eth2_interop_keypairs" }
-ethereum-types = "0.8.0"
+ethereum-types = "0.9.1"
 eth2_hashing = "0.1.0"
 hex = "0.3"
 int_to_bytes = { path = "../utils/int_to_bytes" }
@@ -38,8 +38,21 @@ rand_xorshift = "0.2.0"
 cached_tree_hash = { path = "../utils/cached_tree_hash" }
 serde_yaml = "0.8.11"
 tempfile = "3.1.0"
+arbitrary = { version = "0.4", features = ["derive"], optional = true }
 
 [dev-dependencies]
 env_logger = "0.7.1"
 serde_json = "1.0.41"
 criterion = "0.3.0"
+
+[features]
+arbitrary-fuzz = [
+  "arbitrary",
+  "ethereum-types/arbitrary",
+  "bls/arbitrary",
+  "eth2_ssz/arbitrary",
+  "eth2_ssz_types/arbitrary",
+  "merkle_proof/arbitrary",
+  "swap_or_not_shuffle/arbitrary",
+  "tree_hash/arbitrary",
+]

eth2/types/Cargo.toml

@@ -11,6 +11,7 @@ use tree_hash_derive::TreeHash;
 /// A Validators aggregate attestation and selection proof.
 ///
 /// Spec v0.10.1
+#[cfg_attr(feature = "arbitrary-fuzz", derive(arbitrary::Arbitrary))]
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Encode, Decode, TestRandom, TreeHash)]
 #[serde(bound = "T: EthSpec")]
 pub struct AggregateAndProof<T: EthSpec> {

eth2/types/src/aggregate_and_proof.rs

@@ -20,6 +20,7 @@ pub enum Error {
 /// Details an attestation that can be slashable.
 ///
 /// Spec v0.11.1
+#[cfg_attr(feature = "arbitrary-fuzz", derive(arbitrary::Arbitrary))]
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Encode, Decode, TreeHash, TestRandom)]
 #[serde(bound = "T: EthSpec")]
 pub struct Attestation<T: EthSpec> {