Re-export context_deserialize_derive inside context_deserialize (#7852)

macladson · web-flow · commit 152f2bb2e46c · 2025-08-12T05:16:19.000Z
Re-export `context_deserialize_derive` inside of `context_deserialize` so they are both available from the same interface, which matches how popular crates (like `serde`) handle this.

This also nests both crates inside a new `context_deserialize` directory which will make it easier to eventually spin out into a different repo (if/when) we decide to do that (plus I prefer it aesthetically).
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -48,8 +48,8 @@ members = [
     "common/validator_dir",
     "common/warp_utils",
     "common/workspace_members",
-    "consensus/context_deserialize",
-    "consensus/context_deserialize_derive",
+    "consensus/context_deserialize/context_deserialize",
+    "consensus/context_deserialize/context_deserialize_derive",
     "consensus/fixed_bytes",
     "consensus/fork_choice",
     "consensus/int_to_bytes",
@@ -123,8 +123,10 @@ clap_utils = { path = "common/clap_utils" }
 compare_fields = { path = "common/compare_fields" }
 compare_fields_derive = { path = "common/compare_fields_derive" }
 console-subscriber = "0.4"
-context_deserialize = { path = "consensus/context_deserialize" }
-context_deserialize_derive = { path = "consensus/context_deserialize_derive" }
+context_deserialize = { path = "consensus/context_deserialize/context_deserialize", features = [
+    "all",
+] }
+context_deserialize_derive = { path = "consensus/context_deserialize/context_deserialize_derive" }
 criterion = "0.5"
 delay_map = "0.4"
 deposit_contract = { path = "common/deposit_contract" }
diff --git a/consensus/context_deserialize/Cargo.toml b/consensus/context_deserialize/Cargo.toml
diff --git a/consensus/context_deserialize/context_deserialize/Cargo.toml b/consensus/context_deserialize/context_deserialize/Cargo.toml
@@ -0,0 +1,17 @@
+[package]
+name = "context_deserialize"
+version = "0.1.0"
+edition = "2021"
+
+[features]
+default = ["derive"]
+derive = ["dep:context_deserialize_derive"]
+milhouse = ["dep:milhouse"]
+ssz = ["dep:ssz_types"]
+all = ["derive", "milhouse", "ssz"]
+
+[dependencies]
+context_deserialize_derive = { version = "0.1.0", path = "../context_deserialize_derive", optional = true }
+milhouse = { workspace = true, optional = true }
+serde = { workspace = true }
+ssz_types = { workspace = true, optional = true }
diff --git a/consensus/context_deserialize/context_deserialize/src/impls/core.rs b/consensus/context_deserialize/context_deserialize/src/impls/core.rs
diff --git a/consensus/context_deserialize/context_deserialize/src/impls/milhouse.rs b/consensus/context_deserialize/context_deserialize/src/impls/milhouse.rs
diff --git a/consensus/context_deserialize/context_deserialize/src/impls/mod.rs b/consensus/context_deserialize/context_deserialize/src/impls/mod.rs
@@ -0,0 +1,7 @@
+mod core;
+
+#[cfg(feature = "milhouse")]
+mod milhouse;
+
+#[cfg(feature = "ssz")]
+mod ssz;
diff --git a/consensus/context_deserialize/context_deserialize/src/impls/ssz.rs b/consensus/context_deserialize/context_deserialize/src/impls/ssz.rs
@@ -1,10 +1,13 @@
-use crate::serde::de::Error;
 use crate::ContextDeserialize;
-use serde::de::Deserializer;
-use serde::Deserialize;
-use ssz_types::length::{Fixed, Variable};
-use ssz_types::typenum::Unsigned;
-use ssz_types::{Bitfield, FixedVector};
+use serde::{
+    de::{Deserializer, Error},
+    Deserialize,
+};
+use ssz_types::{
+    length::{Fixed, Variable},
+    typenum::Unsigned,
+    Bitfield, FixedVector,
+};
 
 impl<'de, C, T, N> ContextDeserialize<'de, C> for FixedVector<T, N>
 where
diff --git a/consensus/context_deserialize/context_deserialize/src/lib.rs b/consensus/context_deserialize/context_deserialize/src/lib.rs
@@ -1,8 +1,8 @@
-pub mod impls;
-pub mod milhouse;
-pub mod ssz_impls;
+mod impls;
+
+#[cfg(feature = "derive")]
+pub use context_deserialize_derive::context_deserialize;
 
-extern crate serde;
 use serde::de::Deserializer;
 
 /// General-purpose deserialization trait that accepts extra context `C`.
diff --git a/consensus/context_deserialize/context_deserialize_derive/Cargo.toml b/consensus/context_deserialize/context_deserialize_derive/Cargo.toml
diff --git a/consensus/context_deserialize/context_deserialize_derive/src/lib.rs b/consensus/context_deserialize/context_deserialize_derive/src/lib.rs
diff --git a/consensus/context_deserialize/context_deserialize_derive/tests/context_deserialize_derive.rs b/consensus/context_deserialize/context_deserialize_derive/tests/context_deserialize_derive.rs
@@ -1,5 +1,4 @@
-use context_deserialize::ContextDeserialize;
-use context_deserialize_derive::context_deserialize;
+use context_deserialize::{context_deserialize, ContextDeserialize};
 use serde::{Deserialize, Serialize};
 
 #[test]
diff --git a/consensus/types/Cargo.toml b/consensus/types/Cargo.toml
@@ -1,7 +1,10 @@
 [package]
 name = "types"
 version = "0.2.1"
-authors = ["Paul Hauner <paul@paulhauner.com>", "Age Manning <Age@AgeManning.com>"]
+authors = [
+    "Paul Hauner <paul@paulhauner.com>",
+    "Age Manning <Age@AgeManning.com>",
+]
 edition = { workspace = true }
 
 [features]
@@ -28,7 +31,6 @@ bls = { workspace = true }
 compare_fields = { workspace = true }
 compare_fields_derive = { workspace = true }
 context_deserialize = { workspace = true }
-context_deserialize_derive = { workspace = true }
 derivative = { workspace = true }
 eth2_interop_keypairs = { path = "../../common/eth2_interop_keypairs" }
 ethereum_hashing = { workspace = true }
diff --git a/consensus/types/src/attestation_data.rs b/consensus/types/src/attestation_data.rs
@@ -1,7 +1,7 @@
 use crate::slot_data::SlotData;
 use crate::test_utils::TestRandom;
 use crate::{Checkpoint, ForkName, Hash256, SignedRoot, Slot};
-use context_deserialize_derive::context_deserialize;
+use context_deserialize::context_deserialize;
 use serde::{Deserialize, Serialize};
 use ssz_derive::{Decode, Encode};
 use test_random_derive::TestRandom;
diff --git a/consensus/types/src/beacon_block_header.rs b/consensus/types/src/beacon_block_header.rs
@@ -1,7 +1,7 @@
 use crate::test_utils::TestRandom;
 use crate::*;
 
-use context_deserialize_derive::context_deserialize;
+use context_deserialize::context_deserialize;
 use serde::{Deserialize, Serialize};
 use ssz_derive::{Decode, Encode};
 use test_random_derive::TestRandom;
diff --git a/consensus/types/src/checkpoint.rs b/consensus/types/src/checkpoint.rs
@@ -1,6 +1,6 @@
 use crate::test_utils::TestRandom;
 use crate::{Epoch, ForkName, Hash256};
-use context_deserialize_derive::context_deserialize;
+use context_deserialize::context_deserialize;
 use serde::{Deserialize, Serialize};
 use ssz_derive::{Decode, Encode};
 use test_random_derive::TestRandom;
diff --git a/consensus/types/src/fork.rs b/consensus/types/src/fork.rs
@@ -1,6 +1,6 @@
 use crate::test_utils::TestRandom;
 use crate::{Epoch, ForkName};
-use context_deserialize_derive::context_deserialize;
+use context_deserialize::context_deserialize;
 
 use serde::{Deserialize, Serialize};
 use ssz_derive::{Decode, Encode};
diff --git a/consensus/types/src/fork_data.rs b/consensus/types/src/fork_data.rs
@@ -1,6 +1,6 @@
 use crate::test_utils::TestRandom;
 use crate::{ForkName, Hash256, SignedRoot};
-use context_deserialize_derive::context_deserialize;
+use context_deserialize::context_deserialize;
 
 use serde::{Deserialize, Serialize};
 use ssz_derive::{Decode, Encode};
diff --git a/consensus/types/src/lib.rs b/consensus/types/src/lib.rs
@@ -287,8 +287,7 @@ pub use bls::{
     AggregatePublicKey, AggregateSignature, Keypair, PublicKey, PublicKeyBytes, SecretKey,
     Signature, SignatureBytes,
 };
-pub use context_deserialize::ContextDeserialize;
-pub use context_deserialize_derive::context_deserialize;
+pub use context_deserialize::{context_deserialize, ContextDeserialize};
 pub use kzg::{KzgCommitment, KzgProof, VERSIONED_HASH_VERSION_KZG};
 pub use milhouse::{self, List, Vector};
 pub use ssz_types::{typenum, typenum::Unsigned, BitList, BitVector, FixedVector, VariableList};
diff --git a/testing/ef_tests/Cargo.toml b/testing/ef_tests/Cargo.toml
@@ -18,7 +18,6 @@ bls = { workspace = true }
 compare_fields = { workspace = true }
 compare_fields_derive = { workspace = true }
 context_deserialize = { workspace = true }
-context_deserialize_derive = { workspace = true }
 derivative = { workspace = true }
 eth2_network_config = { workspace = true }
 ethereum_ssz = { workspace = true }
diff --git a/testing/ef_tests/src/cases/ssz_generic.rs b/testing/ef_tests/src/cases/ssz_generic.rs
@@ -4,8 +4,7 @@ use super::*;
 use crate::cases::common::{DecimalU128, DecimalU256, SszStaticType};
 use crate::cases::ssz_static::{check_serialization, check_tree_hash};
 use crate::decode::{context_yaml_decode_file, log_file_access, snappy_decode_file};
-use context_deserialize::ContextDeserialize;
-use context_deserialize_derive::context_deserialize;
+use context_deserialize::{context_deserialize, ContextDeserialize};
 use serde::{de::Error as SerdeError, Deserialize, Deserializer};
 use ssz_derive::{Decode, Encode};
 use tree_hash::TreeHash;
