cfg-gate the legacy refactor (#269)

* cfg-gate the refactor

.github/workflows/build_nix.yml

@@ -11,6 +11,12 @@ on:
 
 jobs:
   nix:
+    strategy:
+      matrix:
+        flags: ["--cfg legacy_builder_refactored", ""]
+    env:
+      RUSTFLAGS: "${{ matrix.flags }}"
+      RUSTDOCFLAGS: "${{ matrix.flags }}"
     runs-on: ubuntu-latest
     timeout-minutes: 90
     steps:

.github/workflows/lint.yml

@@ -14,9 +14,14 @@ concurrency:
 
 jobs:
   lint:
+    strategy:
+      matrix:
+        flags: ["--cfg legacy_builder_refactored", ""]
     runs-on: ubuntu-latest
 
     env:
+      RUSTFLAGS: "${{ matrix.flags }}"
+      RUSTDOCFLAGS: "${{ matrix.flags }}"
       RUST_LOG: info
     steps:
       - uses: actions/checkout@v4

.github/workflows/test.yml

@@ -14,9 +14,14 @@ concurrency:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        flags: ["--cfg legacy_builder_refactored", ""]
     env:
+      RUSTFLAGS: "${{ matrix.flags }}"
+      RUSTDOCFLAGS: "${{ matrix.flags }}"
       RUST_LOG: info
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
 

Cargo.toml

@@ -26,6 +26,7 @@ either = "1.13"
 futures = "0.3"
 jf-vid = { version = "0.1.0", git = "https://github.com/EspressoSystems/jellyfish", tag = "0.4.5" }
 hex = "0.4.3"
+lru = "0.12"
 multimap = "0.10.0"
 nonempty-collections = "0.2"
 once_cell = "1.20"
@@ -56,13 +57,15 @@ version = "0.1.56"
 edition = "2021"
 
 [workspace.lints.rust]
-unexpected_cfgs = { level = "warn", check-cfg = ['cfg(coverage_nightly)'] }
+unexpected_cfgs = { level = "warn", check-cfg = [
+    'cfg(legacy_builder_refactored, values(none()))',
+    'cfg(coverage_nightly)',
+] }
 
 [workspace.lints.clippy]
 disallowed-names = "deny"
 doc_markdown = "deny"
 doc_link_with_quotes = "deny"
-clone_on_ref_ptr = "deny"
 
 [workspace.lints.rustdoc]
 broken_intra_doc_links = "deny"

crates/legacy/Cargo.toml

@@ -20,6 +20,7 @@ futures = { workspace = true }
 hotshot = { workspace = true }
 hotshot-builder-api = { workspace = true }
 hotshot-types = { workspace = true }
+lru = { workspace = true }
 once_cell = { workspace = true }
 serde = { workspace = true, features = ["derive"] }
 sha2 = { workspace = true }

crates/legacy/src/lib.rs

@@ -1,18 +1,5 @@
-//! Builder Phase 1
-//! It mainly provides three API services to hotshot proposers:
-//! 1. Serves a proposer(leader)'s request to provide blocks information
-//! 2. Serves a proposer(leader)'s request to provide the full blocks information
-//! 3. Serves a proposer(leader)'s request to provide the block header information
-//!
-//! It also provides one API service to external users:
-//! 1. Serves a user's request to submit a private transaction
-#![cfg_attr(coverage_nightly, feature(coverage_attribute))]
+#[cfg_attr(legacy_builder_refactored, path = "refactored/lib.rs")]
+#[cfg_attr(not(legacy_builder_refactored), path = "old/lib.rs")]
+mod implementation;
 
-pub mod block_size_limits;
-pub mod block_store;
-pub mod service;
-
-// tracking the testing
-#[cfg(test)]
-#[cfg_attr(coverage_nightly, coverage(off))]
-pub mod testing;
+pub use implementation::*;