restructure repo

Author: tac0turtle

Cargo.toml

@@ -1,6 +1,12 @@
 [workspace]
 resolver = "2"
-members = ["crates/rollkit"]
+members = [
+    "bin/lumen",
+    "crates/common",
+    "crates/node",
+    "crates/rollkit",
+    "crates/e2e-tests",
+]
 
 [workspace.package]
 version = "0.1.0"
@@ -13,52 +19,52 @@ authors = ["Rollkit Contributors"]
 
 [workspace.dependencies]
 # Reth dependencies - Using the latest stable versions
-reth = { version = "1.1.3", default-features = false }
-reth-cli-util = { version = "1.1.3", default-features = false }
-reth-ethereum-cli = { version = "1.1.3", default-features = false }
-reth-ethereum = { version = "1.1.3", default-features = false }
-reth-node-builder = { version = "1.1.3", default-features = false }
-reth-chainspec = { version = "1.1.3", default-features = false }
-reth-ethereum-payload-builder = { version = "1.1.3", default-features = false }
-reth-payload-primitives = { version = "1.1.3", default-features = false }
-reth-primitives = { version = "1.1.3", default-features = false }
-reth-primitives-traits = { version = "1.1.3", default-features = false }
-reth-node-api = { version = "1.1.3", default-features = false }
-reth-provider = { version = "1.1.3", default-features = false }
-reth-payload-builder = { version = "1.1.3", default-features = false }
-reth-basic-payload-builder = { version = "1.1.3", default-features = false }
-reth-engine-local = { version = "1.1.3", default-features = false }
-reth-revm = { version = "1.1.3", default-features = false }
-reth-trie-db = { version = "1.1.3", default-features = false }
-reth-node-types = { version = "1.1.3", default-features = false }
-reth-payload-builder-primitives = { version = "1.1.3", default-features = false }
-reth-execution-types = { version = "1.1.3", default-features = false }
-reth-evm-ethereum = { version = "1.1.3", default-features = false }
-reth-evm = { version = "1.1.3", default-features = false }
-reth-errors = { version = "1.1.3", default-features = false }
-reth-node-core = { version = "1.1.3", default-features = false }
-reth-rpc-builder = { version = "1.1.3", default-features = false }
-reth-rpc-api = { version = "1.1.3", default-features = false }
-reth-rpc-engine-api = { version = "1.1.3", default-features = false }
-reth-engine-primitives = { version = "1.1.3", default-features = false }
-reth-ethereum-primitives = { version = "1.1.3", default-features = false }
+reth = { version = "1.1", default-features = false }
+reth-cli-util = { version = "1.1", default-features = false }
+reth-ethereum-cli = { version = "1.1", default-features = false }
+reth-ethereum = { version = "1.1", default-features = false }
+reth-node-builder = { version = "1.1", default-features = false }
+reth-chainspec = { version = "1.1", default-features = false }
+reth-ethereum-payload-builder = { version = "1.1", default-features = false }
+reth-payload-primitives = { version = "1.1", default-features = false }
+reth-primitives = { version = "1.1", default-features = false }
+reth-primitives-traits = { version = "1.1", default-features = false }
+reth-node-api = { version = "1.1", default-features = false }
+reth-provider = { version = "1.1", default-features = false }
+reth-payload-builder = { version = "1.1", default-features = false }
+reth-basic-payload-builder = { version = "1.1", default-features = false }
+reth-engine-local = { version = "1.1", default-features = false }
+reth-revm = { version = "1.1", default-features = false }
+reth-trie-db = { version = "1.1", default-features = false }
+reth-node-types = { version = "1.1", default-features = false }
+reth-payload-builder-primitives = { version = "1.1", default-features = false }
+reth-execution-types = { version = "1.1", default-features = false }
+reth-evm-ethereum = { version = "1.1", default-features = false }
+reth-evm = { version = "1.1", default-features = false }
+reth-errors = { version = "1.1", default-features = false }
+reth-node-core = { version = "1.1", default-features = false }
+reth-rpc-builder = { version = "1.1", default-features = false }
+reth-rpc-api = { version = "1.1", default-features = false }
+reth-rpc-engine-api = { version = "1.1", default-features = false }
+reth-engine-primitives = { version = "1.1", default-features = false }
+reth-ethereum-primitives = { version = "1.1", default-features = false }
 
 # Test dependencies
-reth-testing-utils = { version = "1.1.3", default-features = false }
-reth-db = { version = "1.1.3", default-features = false }
-reth-transaction-pool = { version = "1.1.3", default-features = false }
-reth-consensus = { version = "1.1.3", default-features = false }
-reth-tasks = { version = "1.1.3", default-features = false }
-reth-tracing = { version = "1.1.3", default-features = false }
+reth-testing-utils = { version = "1.1", default-features = false }
+reth-db = { version = "1.1", default-features = false }
+reth-transaction-pool = { version = "1.1", default-features = false }
+reth-consensus = { version = "1.1", default-features = false }
+reth-tasks = { version = "1.1", default-features = false }
+reth-tracing = { version = "1.1", default-features = false }
 
 # Alloy dependencies
-alloy-rpc-types = { version = "0.7.3", default-features = false }
-alloy-rpc-types-engine = { version = "0.7.3", default-features = false }
+alloy-rpc-types = { version = "0.7", default-features = false }
+alloy-rpc-types-engine = { version = "0.7", default-features = false }
 alloy-primitives = { version = "0.8", default-features = false }
-alloy-eips = { version = "0.7.3", default-features = false }
-alloy-consensus = { version = "0.7.3", default-features = false }
+alloy-eips = { version = "0.7", default-features = false }
+alloy-consensus = { version = "0.7", default-features = false }
 alloy-rlp = { version = "0.3", default-features = false }
-alloy-genesis = { version = "0.7.3", default-features = false }
+alloy-genesis = { version = "0.7", default-features = false }
 
 # Core dependencies
 eyre = "0.6"
@@ -175,4 +181,4 @@ too_long_first_doc_paragraph = "allow"
 [profile.release]
 opt-level = 3
 lto = "thin"
-strip = "debuginfo"
+strip = "debuginfo"

Makefile

@@ -2,7 +2,7 @@
 
 # Build configuration
 CARGO = cargo
-BINARY_NAME = rollkit-reth
+BINARY_NAME = lumen
 TARGET_DIR = target
 
 # Default target
@@ -15,35 +15,35 @@ help:
 
 ##@ Building
 
-## build: Build the rollkit-reth binary in release mode
+## build: Build the lumen binary in release mode
 build:
 	$(CARGO) build --release --bin $(BINARY_NAME)
 
-## build-dev: Build the rollkit-reth binary in debug mode
+## build-dev: Build the lumen binary in debug mode
 build-dev:
 	$(CARGO) build --bin $(BINARY_NAME)
 
 ##@ Testing
 
 ## test: Run all tests
 test:
-	$(CARGO) test --all
+	$(CARGO) test --workspace
 
 ## test-verbose: Run all tests with verbose output
 test-verbose:
-	$(CARGO) test --all -- --nocapture
+	$(CARGO) test --workspace -- --nocapture
 
 ## test-unit: Run unit tests only
 test-unit:
 	$(CARGO) test --lib
 
 ## test-integration: Run integration tests only  
 test-integration:
-	$(CARGO) test --test '*'
+	$(CARGO) test -p lumen-e2e-tests
 
 ##@ Development
 
-## run: Run the rollkit-reth node with default settings
+## run: Run the lumen node with default settings
 run: build-dev
 	./$(TARGET_DIR)/debug/$(BINARY_NAME) node
 
@@ -65,7 +65,7 @@ lint:
 
 ## check: Run cargo check
 check:
-	$(CARGO) check --all
+	$(CARGO) check --workspace
 
 ##@ Maintenance
 
@@ -89,4 +89,22 @@ doc:
 
 ## doc-all: Build documentation including dependencies
 doc-all:
-	$(CARGO) doc --open
+	$(CARGO) doc --open
+
+##@ Workspace Management
+
+## build-all: Build all workspace members
+build-all:
+	$(CARGO) build --workspace --release
+
+## test-node: Test only the node crate
+test-node:
+	$(CARGO) test -p lumen-node
+
+## test-rollkit: Test only the rollkit crate
+test-rollkit:
+	$(CARGO) test -p lumen-rollkit
+
+## test-common: Test only the common crate
+test-common:
+	$(CARGO) test -p lumen-common

README.md

@@ -50,16 +50,16 @@ make test
 
 ## Usage
 
-### Running the Rollkit-Reth Node
+### Running the Lumen Node
 
 Basic usage:
 ```bash
-./target/release/rollkit-reth node
+./target/release/lumen node
 ```
 
 With custom configuration:
 ```bash
-./target/release/rollkit-reth node \
+./target/release/lumen node \
     --chain <CHAIN_SPEC> \
     --datadir <DATA_DIR> \
     --http \
@@ -96,20 +96,40 @@ When using the Engine API, you can include transactions in the payload attribute
 
 ## Architecture
 
+### Modular Design
+
+Lumen follows a modular architecture similar to Odyssey, with clear separation of concerns:
+
+- **`bin/lumen`**: The main executable binary
+- **`crates/common`**: Shared utilities and constants used across all crates
+- **`crates/node`**: Core node implementation including the payload builder
+- **`crates/rollkit`**: Rollkit-specific types and integration logic
+- **`crates/e2e-tests`**: Comprehensive end-to-end tests
+
+This modular design allows for:
+- Better code organization and maintainability
+- Easier testing of individual components
+- Clear separation between Rollkit-specific and general node logic
+- Reusable components for other projects
+
 ### Components
 
-1. **RollkitPayloadBuilder** (`crates/rollkit/src/builder.rs`)
+1. **RollkitPayloadBuilder** (`crates/node/src/builder.rs`)
    - Handles payload construction with transactions from Engine API
    - Manages state execution and block assembly
 
-2. **RollkitEngineTypes** (`crates/rollkit/bin/src/main.rs`)
+2. **RollkitEngineTypes** (`bin/lumen/src/main.rs`)
    - Custom Engine API types supporting transaction attributes
    - Payload validation and attribute processing
 
-3. **RollkitEngineValidator** (`crates/rollkit/bin/src/main.rs`)
+3. **RollkitEngineValidator** (`bin/lumen/src/main.rs`)
    - Modified validator for Rollkit-specific requirements
    - Bypasses certain validations while maintaining security
 
+4. **Rollkit Types** (`crates/rollkit/src/types.rs`)
+   - Rollkit-specific payload attributes and types
+   - Transaction encoding/decoding utilities
+
 ### Transaction Flow
 
 1. Rollkit submits transactions via Engine API payload attributes
@@ -140,18 +160,35 @@ All standard Reth configuration options are supported. Key options for Rollkit i
 
 ```
 lumen/
+├── bin/
+│   └── lumen/                  # Main binary
+│       ├── Cargo.toml
+│       └── src/
+│           └── main.rs         # Binary with Engine API integration
 ├── crates/
-│   └── rollkit/
-│       ├── src/
-│       │   ├── lib.rs          # Library root
-│       │   ├── builder.rs      # Payload builder implementation
-│       │   ├── config.rs       # Configuration types
-│       │   ├── types.rs        # Rollkit-specific types
-│       │   └── tests.rs        # Unit tests
-│       ├── tests/              # Integration tests
-│       └── bin/
-│           └── src/
-│               └── main.rs     # Binary with Engine API integration
+│   ├── common/                 # Shared utilities and constants
+│   │   ├── Cargo.toml
+│   │   └── src/
+│   │       ├── lib.rs
+│   │       └── constants.rs
+│   ├── node/                   # Core node implementation
+│   │   ├── Cargo.toml
+│   │   └── src/
+│   │       ├── lib.rs
+│   │       ├── builder.rs     # Payload builder implementation
+│   │       └── config.rs      # Configuration types
+│   ├── rollkit/                # Rollkit-specific types
+│   │   ├── Cargo.toml
+│   │   └── src/
+│   │       ├── lib.rs
+│   │       └── types.rs       # Rollkit payload attributes
+│   └── e2e-tests/              # End-to-end tests
+│       ├── Cargo.toml
+│       └── src/
+│           ├── lib.rs
+│           └── *.rs            # Test files
+├── etc/                        # Configuration files
+│   └── lumen-genesis.json      # Genesis configuration
 ├── Cargo.toml                  # Workspace configuration
 ├── Makefile                    # Build automation
 └── README.md                   # This file
@@ -200,7 +237,7 @@ make run-dev
 
 Enable detailed logging:
 ```bash
-RUST_LOG=debug,rollkit=trace ./target/release/rollkit-reth node
+RUST_LOG=debug,lumen=trace ./target/release/lumen node
 ```
 
 ## Contributing

bin/lumen/Cargo.toml

@@ -0,0 +1,51 @@
+[package]
+name = "lumen"
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+homepage.workspace = true
+repository.workspace = true
+description = "Lumen node binary"
+
+[[bin]]
+name = "lumen"
+path = "src/main.rs"
+
+[dependencies]
+# Core lumen crates
+lumen-node = { path = "../../crates/node" }
+lumen-common = { path = "../../crates/common" }
+
+# Reth CLI and core dependencies
+reth-cli-util.workspace = true
+reth-ethereum-cli.workspace = true
+reth-ethereum = { workspace = true, features = ["node", "cli", "pool"] }
+reth-node-builder.workspace = true
+reth-chainspec.workspace = true
+
+# Core dependencies
+eyre.workspace = true
+tracing.workspace = true
+tokio = { workspace = true, features = ["full"] }
+clap = { workspace = true, features = ["derive", "env"] }
+
+[lints]
+workspace = true
+
+[features]
+default = ["jemalloc"]
+
+jemalloc = ["reth-cli-util/jemalloc", "reth-ethereum-cli/jemalloc"]
+jemalloc-prof = ["reth-cli-util/jemalloc-prof"]
+tracy-allocator = ["reth-cli-util/tracy-allocator"]
+
+asm-keccak = ["reth-ethereum-cli/asm-keccak"]
+
+dev = ["reth-ethereum-cli/dev", "reth-ethereum/arbitrary"]
+
+min-error-logs = ["tracing/release_max_level_error"]
+min-warn-logs = ["tracing/release_max_level_warn"]
+min-info-logs = ["tracing/release_max_level_info"]
+min-debug-logs = ["tracing/release_max_level_debug"]
+min-trace-logs = ["tracing/release_max_level_trace"]

crates/rollkit/bin/src/main.rs bin/lumen/src/main.rscrates/rollkit/bin/src/main.rs renamed to bin/lumen/src/main.rs

@@ -48,10 +48,8 @@ use reth_payload_builder::{EthBuiltPayload, EthPayloadBuilderAttributes, Payload
 use reth_provider::HeaderProvider;
 use reth_revm::cached::CachedReads;
 use reth_trie_db::MerklePatriciaTrie;
-use rollkit_reth::{
-    PayloadAttributesError, RollkitPayloadAttributes, RollkitPayloadBuilder,
-    RollkitPayloadBuilderConfig,
-};
+use lumen_node::{RollkitPayloadBuilder, RollkitPayloadBuilderConfig};
+use lumen_rollkit::{PayloadAttributesError, RollkitPayloadAttributes};
 use serde::{Deserialize, Serialize};
 use std::sync::Arc;
 use thiserror::Error;