fix: feature propagation

paradigmxyz · Oct 19, 2024 · c154a1c · c154a1c
1 parent 9c8f5d8
commit c154a1c
Show file tree

Hide file tree

Showing 36 changed files with 325 additions and 84 deletions.
diff --git a/.config/zepter.yaml b/.config/zepter.yaml
@@ -0,0 +1,40 @@
+version:
+  format: 1
+  # Minimum zepter version that is expected to work. This is just for printing a nice error
+  # message when someone tries to use an older version.
+  binary: 0.13.2
+
+# The examples in the following comments assume crate `A` to have a dependency on crate `B`.
+workflows:
+  check:
+    - [
+        "lint",
+        # Check that `A` activates the features of `B`.
+        "propagate-feature",
+        # These are the features to check:
+        "--features=std,optimism,dev,asm-keccak,jemalloc,jemalloc-prof,tracy-allocator",
+        # Do not try to add a new section into `[features]` of `A` only because `B` expose that feature. There are edge-cases where this is still needed, but we can add them manually.
+        "--left-side-feature-missing=ignore",
+        # Ignore the case that `A` it outside of the workspace. Otherwise it will report errors in external dependencies that we have no influence on.
+        "--left-side-outside-workspace=ignore",
+        # Auxillary flags:
+        "--offline",
+        "--locked",
+        "--show-path",
+        "--quiet",
+      ]
+  default:
+    # Running `zepter` with no subcommand will check & fix.
+    - [$check.0, "--fix"]
+
+# Will be displayed when any workflow fails:
+help:
+  text: |
+    Reth uses the Zepter CLI to detect abnormalities in Cargo features, e.g. missing propagation.
+
+    It looks like one more more checks failed; please check the console output.
+
+    You can try to automatically address them by installing zepter (`cargo install zepter --locked`) and simply running `zepter` in the workspace root.
+  links:
+    - "https://github.com/paradigmxyz/reth/pull/11888"
+    - "https://github.com/ggwpez/zepter"
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -219,6 +219,22 @@ jobs:
         env:
           RUSTFLAGS: -D warnings
 
+  # Check crates correclty propagate features
+  feature-propagation:
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    steps:
+      - uses: actions/checkout@v4
+      - name: fetch deps
+        run: |
+          # Eagerly pull dependencies
+          time cargo metadata --format-version=1 --locked > /dev/null
+      - name: run zepter
+        run: |
+          cargo install zepter -f --locked
+          zepter --version
+          time zepter run check
+
   lint-success:
     name: lint success
     runs-on: ubuntu-latest
@@ -236,6 +252,7 @@ jobs:
       - grafana
       - no-test-deps
       - features
+      - feature-propagation
     timeout-minutes: 30
     steps:
       - name: Decide whether the needed jobs succeeded or failed

diff --git a/bin/reth-bench/Cargo.toml b/bin/reth-bench/Cargo.toml
@@ -76,9 +76,16 @@ reth-tracing.workspace = true
 [features]
 default = ["jemalloc"]
 
-asm-keccak = ["reth-primitives/asm-keccak"]
-
-jemalloc = ["reth-cli-util/jemalloc"]
+asm-keccak = [
+	"reth-primitives/asm-keccak",
+	"reth-node-core/asm-keccak",
+	"alloy-primitives/asm-keccak"
+]
+
+jemalloc = [
+	"reth-cli-util/jemalloc",
+	"reth-node-core/jemalloc"
+]
 jemalloc-prof = ["reth-cli-util/jemalloc-prof"]
 tracy-allocator = ["reth-cli-util/tracy-allocator"]
 

diff --git a/bin/reth/Cargo.toml b/bin/reth/Cargo.toml
@@ -104,14 +104,21 @@ default = ["jemalloc"]
 
 dev = ["reth-cli-commands/dev"]
 
-asm-keccak = ["reth-node-core/asm-keccak", "reth-primitives/asm-keccak"]
+asm-keccak = [
+	"reth-node-core/asm-keccak",
+	"reth-primitives/asm-keccak",
+	"alloy-primitives/asm-keccak"
+]
 
 jemalloc = [
     "reth-cli-util/jemalloc",
     "reth-node-core/jemalloc",
     "reth-node-metrics/jemalloc",
 ]
-jemalloc-prof = ["reth-cli-util/jemalloc"]
+jemalloc-prof = [
+	"reth-cli-util/jemalloc",
+	"reth-cli-util/jemalloc-prof"
+]
 tracy-allocator = ["reth-cli-util/tracy-allocator"]
 
 min-error-logs = ["tracing/release_max_level_error"]

diff --git a/crates/blockchain-tree/Cargo.toml b/crates/blockchain-tree/Cargo.toml
@@ -64,4 +64,10 @@ alloy-consensus.workspace = true
 
 [features]
 test-utils = []
-optimism = ["reth-primitives/optimism", "reth-provider/optimism"]
+optimism = [
+	"reth-primitives/optimism",
+	"reth-provider/optimism",
+	"reth-execution-types/optimism",
+	"reth-db/optimism",
+	"reth-db-api/optimism"
+]
diff --git a/crates/chainspec/Cargo.toml b/crates/chainspec/Cargo.toml
@@ -41,11 +41,14 @@ alloy-genesis.workspace = true
 [features]
 default = ["std"]
 std = [
-    "alloy-chains/std",
-    "alloy-eips/std",
-    "alloy-genesis/std",
-    "alloy-primitives/std",
-    "alloy-trie/std",
+	"alloy-chains/std",
+	"alloy-eips/std",
+	"alloy-genesis/std",
+	"alloy-primitives/std",
+	"alloy-trie/std",
+	"reth-primitives-traits/std",
+	"alloy-consensus/std",
+	"once_cell/std"
 ]
 arbitrary = ["alloy-chains/arbitrary"]
 test-utils = []
diff --git a/crates/consensus/auto-seal/Cargo.toml b/crates/consensus/auto-seal/Cargo.toml
@@ -45,4 +45,12 @@ tokio-stream.workspace = true
 tracing.workspace = true
 
 [features]
-optimism = ["reth-provider/optimism", "reth-optimism-consensus"]
+optimism = [
+	"reth-provider/optimism",
+	"reth-optimism-consensus",
+	"reth-beacon-consensus/optimism",
+	"reth-execution-types/optimism",
+	"reth-optimism-consensus?/optimism",
+	"reth-primitives/optimism",
+	"revm-primitives/optimism"
+]
diff --git a/crates/consensus/beacon/Cargo.toml b/crates/consensus/beacon/Cargo.toml
@@ -77,8 +77,10 @@ assert_matches.workspace = true
 
 [features]
 optimism = [
-    "reth-chainspec",
-    "reth-primitives/optimism",
-    "reth-provider/optimism",
-    "reth-blockchain-tree/optimism",
+	"reth-chainspec",
+	"reth-primitives/optimism",
+	"reth-provider/optimism",
+	"reth-blockchain-tree/optimism",
+	"reth-db/optimism",
+	"reth-db-api/optimism"
 ]
diff --git a/crates/consensus/consensus/Cargo.toml b/crates/consensus/consensus/Cargo.toml
@@ -23,5 +23,8 @@ derive_more.workspace = true
 
 [features]
 default = ["std"]
-std = []
+std = [
+	"reth-primitives/std",
+	"alloy-primitives/std"
+]
 test-utils = []
diff --git a/crates/engine/local/Cargo.toml b/crates/engine/local/Cargo.toml
@@ -46,4 +46,8 @@ op-alloy-rpc-types-engine = { workspace = true, optional = true }
 workspace = true
 
 [features]
-optimism = ["op-alloy-rpc-types-engine"]
+optimism = [
+	"op-alloy-rpc-types-engine",
+	"reth-beacon-consensus/optimism",
+	"reth-provider/optimism"
+]
diff --git a/crates/engine/util/Cargo.toml b/crates/engine/util/Cargo.toml
@@ -50,5 +50,8 @@ tracing.workspace = true
 
 [features]
 optimism = [
-    "reth-beacon-consensus/optimism",
+	"reth-beacon-consensus/optimism",
+	"reth-primitives/optimism",
+	"reth-provider/optimism",
+	"revm-primitives/optimism"
 ]
diff --git a/crates/ethereum-forks/Cargo.toml b/crates/ethereum-forks/Cargo.toml
@@ -43,9 +43,12 @@ default = ["std", "serde", "rustc-hash"]
 arbitrary = ["dep:arbitrary", "dep:proptest", "dep:proptest-derive"]
 serde = ["dep:serde"]
 std = [
-    "alloy-chains/std",
-    "alloy-primitives/std",
-    "thiserror-no-std/std",
-    "rustc-hash/std",
+	"alloy-chains/std",
+	"alloy-primitives/std",
+	"thiserror-no-std/std",
+	"rustc-hash/std",
+	"alloy-consensus/std",
+	"once_cell/std",
+	"serde?/std"
 ]
 rustc-hash = ["dep:rustc-hash"]
diff --git a/crates/ethereum/evm/Cargo.toml b/crates/ethereum/evm/Cargo.toml
@@ -42,4 +42,14 @@ alloy-genesis.workspace = true
 
 [features]
 default = ["std"]
-std = []
+std = [
+	"reth-consensus/std",
+	"reth-primitives/std",
+	"reth-revm/std",
+	"alloy-consensus/std",
+	"alloy-eips/std",
+	"alloy-genesis/std",
+	"alloy-primitives/std",
+	"revm-primitives/std",
+	"secp256k1/std"
+]
diff --git a/crates/evm/Cargo.toml b/crates/evm/Cargo.toml
@@ -40,5 +40,16 @@ parking_lot.workspace = true
 
 [features]
 default = ["std"]
-std = ["dep:metrics", "dep:reth-metrics"]
+std = [
+	"dep:metrics",
+	"dep:reth-metrics",
+	"reth-consensus/std",
+	"reth-primitives/std",
+	"reth-primitives-traits/std",
+	"reth-revm/std",
+	"alloy-eips/std",
+	"alloy-primitives/std",
+	"revm-primitives/std",
+	"revm/std"
+]
 test-utils = ["dep:parking_lot"]
diff --git a/crates/evm/execution-errors/Cargo.toml b/crates/evm/execution-errors/Cargo.toml
@@ -26,4 +26,9 @@ derive_more.workspace = true
 
 [features]
 default = ["std"]
-std = ["reth-consensus/std"]
+std = [
+	"reth-consensus/std",
+	"alloy-eips/std",
+	"alloy-primitives/std",
+	"revm-primitives/std"
+]
diff --git a/crates/evm/execution-types/Cargo.toml b/crates/evm/execution-types/Cargo.toml
@@ -36,4 +36,10 @@ default = ["std"]
 optimism = ["reth-primitives/optimism", "revm/optimism"]
 serde = ["dep:serde", "reth-trie/serde", "revm/serde"]
 serde-bincode-compat = ["reth-primitives/serde-bincode-compat", "reth-trie/serde-bincode-compat", "serde_with"]
-std = []
+std = [
+	"reth-primitives/std",
+	"alloy-eips/std",
+	"alloy-primitives/std",
+	"revm/std",
+	"serde?/std"
+]
diff --git a/crates/net/p2p/Cargo.toml b/crates/net/p2p/Cargo.toml
@@ -44,4 +44,9 @@ tokio = { workspace = true, features = ["full"] }
 [features]
 default = ["std"]
 test-utils = ["reth-consensus/test-utils", "parking_lot"]
-std = ["reth-consensus/std"]
+std = [
+	"reth-consensus/std",
+	"reth-primitives/std",
+	"alloy-eips/std",
+	"alloy-primitives/std"
+]
diff --git a/crates/node/core/Cargo.toml b/crates/node/core/Cargo.toml
@@ -77,11 +77,17 @@ tempfile.workspace = true
 
 [features]
 optimism = [
-    "reth-primitives/optimism"
+	"reth-primitives/optimism",
+	"reth-db/optimism"
 ]
 # Features for vergen to generate correct env vars
-jemalloc = []
-asm-keccak = []
+jemalloc = [
+	"reth-cli-util/jemalloc"
+]
+asm-keccak = [
+	"reth-primitives/asm-keccak",
+	"alloy-primitives/asm-keccak"
+]
 
 [build-dependencies]
 vergen = { version = "8.0.0", features = ["build", "cargo", "git", "gitcl"] }
diff --git a/crates/optimism/bin/Cargo.toml b/crates/optimism/bin/Cargo.toml
@@ -37,7 +37,15 @@ tracy-allocator = ["reth-cli-util/tracy-allocator"]
 
 asm-keccak = ["reth-optimism-cli/asm-keccak", "reth-optimism-node/asm-keccak"]
 
-optimism = ["reth-optimism-cli/optimism", "reth-optimism-node/optimism"]
+optimism = [
+	"reth-optimism-cli/optimism",
+	"reth-optimism-node/optimism",
+	"reth-optimism-consensus/optimism",
+	"reth-optimism-evm/optimism",
+	"reth-optimism-payload-builder/optimism",
+	"reth-optimism-rpc/optimism",
+	"reth-provider/optimism"
+]
 
 min-error-logs = ["tracing/release_max_level_error"]
 min-warn-logs = ["tracing/release_max_level_warn"]

diff --git a/crates/optimism/chainspec/Cargo.toml b/crates/optimism/chainspec/Cargo.toml
@@ -45,12 +45,14 @@ op-alloy-rpc-types.workspace = true
 [features]
 default = ["std"]
 std = [
-    "alloy-chains/std",
-    "alloy-genesis/std",
-    "alloy-primitives/std",
-    "op-alloy-rpc-types/std",
-    "reth-chainspec/std",
-    "reth-ethereum-forks/std",
-    "reth-primitives-traits/std",
-    "reth-optimism-forks/std",
+	"alloy-chains/std",
+	"alloy-genesis/std",
+	"alloy-primitives/std",
+	"op-alloy-rpc-types/std",
+	"reth-chainspec/std",
+	"reth-ethereum-forks/std",
+	"reth-primitives-traits/std",
+	"reth-optimism-forks/std",
+	"alloy-consensus/std",
+	"once_cell/std"
 ]
diff --git a/crates/optimism/cli/Cargo.toml b/crates/optimism/cli/Cargo.toml
@@ -73,11 +73,14 @@ reth-cli-commands.workspace = true
 
 [features]
 optimism = [
-    "reth-primitives/optimism",
-    "reth-optimism-evm/optimism",
-    "reth-provider/optimism",
-    "reth-node-core/optimism",
-    "reth-optimism-node/optimism",
+	"reth-primitives/optimism",
+	"reth-optimism-evm/optimism",
+	"reth-provider/optimism",
+	"reth-node-core/optimism",
+	"reth-optimism-node/optimism",
+	"reth-execution-types/optimism",
+	"reth-db/optimism",
+	"reth-db-api/optimism"
 ]
 asm-keccak = [
     "alloy-primitives/asm-keccak",

diff --git a/crates/optimism/evm/Cargo.toml b/crates/optimism/evm/Cargo.toml
@@ -52,10 +52,21 @@ alloy-consensus.workspace = true
 
 [features]
 default = ["std"]
-std = []
+std = [
+	"reth-consensus/std",
+	"reth-primitives/std",
+	"reth-revm/std",
+	"alloy-consensus/std",
+	"alloy-eips/std",
+	"alloy-genesis/std",
+	"alloy-primitives/std",
+	"revm-primitives/std",
+	"revm/std"
+]
 optimism = [
-    "reth-primitives/optimism",
-    "reth-execution-types/optimism",
-    "reth-optimism-consensus/optimism",
-    "revm/optimism",
+	"reth-primitives/optimism",
+	"reth-execution-types/optimism",
+	"reth-optimism-consensus/optimism",
+	"revm/optimism",
+	"revm-primitives/optimism"
 ]