feat: add reth test-vectors compact --write|--read (paradigmxyz#11954)

.github/workflows/compact.yml

@@ -0,0 +1,42 @@
+# Ensures that `Compact` codec changes are backwards compatible.
+# 
+# 1) checkout `main`
+# 2) randomly generate and serialize to disk many different type vectors with `Compact` (eg. Header, Transaction, etc)
+# 3) checkout `pr`
+# 4) deserialize previously generated test vectors
+
+on:
+  workflow_dispatch:
+
+env:
+  CARGO_TERM_COLOR: always
+
+name: compact-codec
+jobs:
+  compact-codec:
+    runs-on:
+      group: Reth
+    strategy:
+      matrix:
+        bin:
+          - cargo run --bin reth --features "dev"
+          - cargo run --bin op-reth --features "optimism dev" --manifest-path crates/optimism/bin/Cargo.toml
+    steps:
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-on-failure: true
+      - name: Checkout base
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.base_ref || 'main' }}
+      # On `main` branch, generates test vectors and serializes them to disk using `Compact`.
+      - name: Generate compact vectors
+        run: ${{ matrix.bin }} -- test-vectors compact --write
+      - name: Checkout PR
+        uses: actions/checkout@v4
+        with:
+          clean: false
+      # On incoming merge try to read and decode previously generated vectors with `Compact`
+      - name: Read vectors
+        run: ${{ matrix.bin }} -- test-vectors compact --read

crates/cli/commands/Cargo.toml

@@ -17,6 +17,7 @@ reth-cli.workspace = true
 reth-ethereum-cli.workspace = true
 reth-cli-runner.workspace = true
 reth-cli-util.workspace = true
+reth-codecs = { workspace = true, optional = true }
 reth-config.workspace = true
 reth-consensus.workspace = true
 reth-db = { workspace = true, features = ["mdbx"] }
@@ -38,11 +39,14 @@ reth-node-metrics.workspace = true
 reth-primitives.workspace = true
 reth-provider.workspace = true
 reth-prune.workspace = true
+reth-prune-types = { workspace = true, optional = true }
 reth-stages.workspace = true
+reth-stages-types = { workspace = true, optional = true }
 reth-static-file-types = { workspace = true, features = ["clap"] }
 reth-static-file.workspace = true
 reth-trie = { workspace = true, features = ["metrics"] }
 reth-trie-db = { workspace = true, features = ["metrics"] }
+reth-trie-common = { workspace = true, optional = true }
 
 # ethereum
 alloy-eips.workspace = true
@@ -89,14 +93,22 @@ reth-discv4.workspace = true
 [features]
 default = []
 arbitrary = [
-    "dep:proptest",
-    "dep:arbitrary",
-    "dep:proptest-arbitrary-interop",
-    "reth-primitives/arbitrary",
-    "reth-db-api/arbitrary",
-    "reth-eth-wire/arbitrary",
-    "reth-db/arbitrary",
-    "reth-chainspec/arbitrary",
-    "alloy-eips/arbitrary",
-    "alloy-primitives/arbitrary",
+	"dep:proptest",
+	"dep:arbitrary",
+	"dep:proptest-arbitrary-interop",
+	"reth-primitives/arbitrary",
+	"reth-db-api/arbitrary",
+	"reth-eth-wire/arbitrary",
+	"reth-db/arbitrary",
+	"reth-chainspec/arbitrary",
+	"alloy-eips/arbitrary",
+	"alloy-primitives/arbitrary",
+	"reth-codecs/test-utils",
+	"reth-prune-types/test-utils",
+	"reth-stages-types/test-utils",
+	"reth-trie-common/test-utils",
+	"reth-codecs?/arbitrary",
+	"reth-prune-types?/arbitrary",
+	"reth-stages-types?/arbitrary",
+	"reth-trie-common?/arbitrary"
 ]