Primitives, Components and Interfaces Design

Cargo.toml

@@ -11,8 +11,15 @@ members = [
     "crates/engine",
     "crates/node",
     "crates/network",
-    "crates/scroll-wire"
-]
+    "crates/scroll-wire",
+    "crates/primitives", 
+    "crates/l1", 
+    "crates/database", 
+    "crates/indexer", 
+    "crates/sequencer", 
+    "crates/pipeline", 
+    "crates/provider", 
+    "crates/codec"]
 
 resolver = "2"
 
@@ -111,6 +118,7 @@ alloy-primitives = { version = "0.8.15", default-features = false }
 alloy-rpc-types-engine = { version = "0.11.0", default-features = false }
 
 # scroll-alloy
+scroll-alloy-rpc-types-engine = { git = "https://github.com/scroll-tech/reth.git", branch = "feat/add-deref-blanket-engine-api" }
 scroll-alloy-provider = { git = "https://github.com/scroll-tech/reth.git", branch = "feat/add-deref-blanket-engine-api" }
 scroll-alloy-network = { git = "https://github.com/scroll-tech/reth.git", branch = "feat/add-deref-blanket-engine-api" }
 
@@ -132,7 +140,11 @@ reth-scroll-primitives = { git = "https://github.com/scroll-tech/reth.git", bran
 
 # rollup node
 scroll-engine = { path = "crates/engine" }
+scroll-indexer = { path = "crates/indexer" }
+scroll-l1 = { path = "crates/l1" }
 scroll-network = { path = "crates/network" }
+scroll-pipeline = { path = "crates/pipeline"}
+scroll-primitives = { path = "crates/primitives" }
 scroll-wire = { path = "crates/scroll-wire" }
 rollup-node-manager = { path = "crates/node" }
 

crates/codec/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "codec"
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+exclude.workspace = true
+
+[dependencies]
+
+[lints]
+workspace = true

crates/codec/src/batch.rs

@@ -0,0 +1 @@
+pub struct BatchCodec;

crates/codec/src/chunk.rs

@@ -0,0 +1 @@
+pub struct ChunkCodec;

crates/codec/src/error.rs

@@ -0,0 +1,3 @@
+pub enum CodecError {
+    Error,
+}

crates/codec/src/lib.rs

@@ -0,0 +1,3 @@
+mod batch;
+mod chunk;
+mod error;

crates/database/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "database"
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+exclude.workspace = true
+
+[dependencies]
+
+[lints]
+workspace = true

crates/database/src/lib.rs

@@ -0,0 +1 @@
+pub struct Database;

crates/engine/Cargo.toml

@@ -19,7 +19,7 @@ alloy-rpc-types-engine.workspace = true
 # scroll-alloy
 scroll-alloy-network.workspace = true
 scroll-alloy-provider.workspace = true
-scroll-alloy-rpc-types-engine = { git = "https://github.com/scroll-tech/reth.git", branch = "feat/add-deref-blanket-engine-api" }
+scroll-alloy-rpc-types-engine.workspace = true
 
 # reth
 reth-engine-primitives = { git = "https://github.com/scroll-tech/reth.git", branch = "feat/add-deref-blanket-engine-api", default-features = false, features = ["scroll"] }

crates/indexer/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "scroll-indexer"
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+exclude.workspace = true
+
+[dependencies]
+# rollup-node
+scroll-l1.workspace = true
+scroll-primitives.workspace = true
+
+[lints]
+workspace = true

crates/indexer/src/lib.rs

@@ -0,0 +1,38 @@
+//! A library responsible for indexing data relevant to the L1.
+
+use scroll_l1::L1Event;
+use scroll_primitives::{BatchInput, L1Message};
+use std::sync::Arc;
+
+/// The indexer is responsible for indexing data relevant to the L1.
+#[derive(Debug)]
+pub struct Indexer;
+
+impl Indexer {
+    /// Handles an event from the L1.
+    pub async fn handle_l1_event(&mut self, event: L1Event) {
+        match event {
+            L1Event::Reorg(block_number) => self.handle_reorg(block_number).await,
+            L1Event::NewBlock(block_number) => todo!(),
+            L1Event::Finalized(block_number) => self.handle_finalized(block_number).await,
+            L1Event::L1Message(l1_message) => self.handle_l1_message(l1_message).await,
+            L1Event::PipelineEvent(block_number) => (),
+        }
+    }
+
+    async fn handle_reorg(&mut self, _block_number: u64) {
+        todo!()
+    }
+
+    async fn handle_finalized(&mut self, _block_number: u64) {
+        todo!()
+    }
+
+    async fn handle_l1_message(&mut self, _l1_message: Arc<L1Message>) {
+        todo!()
+    }
+
+    async fn handle_batch_input(&mut self, _batch_input: Arc<BatchInput>) {
+        todo!()
+    }
+}

crates/l1/Cargo.toml

@@ -0,0 +1,22 @@
+[package]
+name = "scroll-l1"
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+exclude.workspace = true
+
+[dependencies]
+# alloy
+alloy-sol-types = { version = "0.8.20", features = ["json"] }
+alloy-contract = { version = "0.11.1", default-features = false }
+alloy-primitives.workspace = true
+
+# rollup-node
+scroll-primitives.workspace = true
+
+# misc
+futures.workspace = true
+
+[lints]
+workspace = true

crates/l1/src/abi.rs

@@ -0,0 +1,17 @@
+use alloy_sol_types::sol;
+
+// L1 Message Queue Contract
+sol!(
+    #[allow(missing_docs)]
+    #[sol(rpc)]
+    L1MessageQueue,
+    "abi/L1MessageQueue.json",
+);
+
+// Scroll Chain Contract
+sol!(
+    #[allow(missing_docs)]
+    #[sol(rpc)]
+    ScrollChain,
+    "abi/ScrollChain.json",
+);

crates/l1/src/constants.rs

@@ -0,0 +1,11 @@
+use alloy_primitives::{address, Address};
+
+// TODO: Update the addresses.
+
+/// The address of the L1 Message Queue contract on mainnet.
+pub const MAINNET_L1_MESSAGE_QUEUE_ADDRESS: Address =
+    address!("0000000000000000000000000000000000000000");
+
+/// The address of the Scroll Chain contract on mainnet.
+pub const MAINNET_L1_SCROLL_CHAIN_ADDRESS: Address =
+    address!("0000000000000000000000000000000000000000");

crates/l1/src/event.rs

@@ -0,0 +1,17 @@
+use scroll_primitives::L1Message;
+use std::sync::Arc;
+
+/// An observation from the L1.
+#[derive(Debug)]
+pub enum L1Event {
+    /// A block containing a pipeline event has been added to the L1.
+    PipelineEvent(u64),
+    /// A new L1 message has been added to the L1.
+    L1Message(Arc<L1Message>),
+    /// A new block has been added to the L1.
+    NewBlock(u64),
+    /// A reorg has occurred at the given block number.
+    Reorg(u64),
+    /// The L1 has been finalized at the given block number.
+    Finalized(u64),
+}

crates/l1/src/lib.rs

@@ -0,0 +1,10 @@
+//! A library containing the logic required to interact with L1.
+
+mod abi;
+mod constants;
+mod event;
+mod watcher;
+
+pub use constants::*;
+pub use event::L1Event;
+pub use watcher::L1Watcher;