update codec and interfaces

frisitano · frisitano · commit 2795c0907aac · 2025-03-03T11:50:13.000+07:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -12,7 +12,14 @@ members = [
     "crates/node",
     "crates/network",
     "crates/scroll-wire",
-    "crates/primitives", "crates/l1", "crates/database", "crates/indexer", "crates/sequencer", "crates/pipeline", "crates/provider"]
+    "crates/primitives", 
+    "crates/l1", 
+    "crates/database", 
+    "crates/indexer", 
+    "crates/sequencer", 
+    "crates/pipeline", 
+    "crates/provider", 
+    "crates/codec"]
 
 resolver = "2"
 
@@ -136,6 +143,7 @@ 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" }
diff --git a/crates/codec/Cargo.toml b/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
diff --git a/crates/codec/src/batch.rs b/crates/codec/src/batch.rs
@@ -0,0 +1 @@
+pub struct BatchCodec;
diff --git a/crates/codec/src/chunk.rs b/crates/codec/src/chunk.rs
@@ -0,0 +1 @@
+pub struct ChunkCodec;
diff --git a/crates/codec/src/error.rs b/crates/codec/src/error.rs
@@ -0,0 +1,3 @@
+pub enum CodecError {
+    Error,
+}
diff --git a/crates/codec/src/lib.rs b/crates/codec/src/lib.rs
@@ -0,0 +1,3 @@
+mod batch;
+mod chunk;
+mod error;
diff --git a/crates/node/Cargo.toml b/crates/node/Cargo.toml
@@ -31,6 +31,7 @@ scroll-engine.workspace = true
 scroll-indexer.workspace = true
 scroll-l1.workspace = true
 scroll-network.workspace = true
+scroll-pipeline.workspace = true
 scroll-wire.workspace = true
 
 # misc
diff --git a/crates/node/src/config.rs b/crates/node/src/config.rs
@@ -1,6 +1,8 @@
 /// The configuration of the rollup node.
 #[derive(Debug)]
 pub struct Config {
+    /// If it is a sequencer node.
     is_sequencer: bool,
+    /// The block time in milliseconds.
     block_time: u64,
 }
diff --git a/crates/node/src/lib.rs b/crates/node/src/lib.rs
@@ -17,6 +17,7 @@ use scroll_network::{
     BlockImportError, BlockImportOutcome, BlockValidation, BlockValidationError, NetworkManager,
     NetworkManagerEvent, NewBlockWithPeer,
 };
+use scroll_pipeline::Pipeline;
 use scroll_wire::NewBlock;
 use std::{
     future::Future,
@@ -38,6 +39,9 @@ pub use consensus::PoAConsensus;
 mod config;
 pub use config::Config;
 
+mod state;
+pub use state::State;
+
 /// The size of the event channel.
 const EVENT_CHANNEL_SIZE: usize = 100;
 
@@ -72,6 +76,8 @@ pub struct RollupNodeManager<C, EC, P> {
     l1_watcher: L1Watcher,
     /// The indexer for indexing rollup node data.
     indexer: Indexer,
+    /// The pipeline that derives the scroll chain from L1 events.
+    pipeline: Pipeline,
     /// The receiver for new blocks received from the network (used to bridge from eth-wire).
     new_block_rx: UnboundedReceiverStream<NewBlockWithPeer>,
     /// The forkchoice state of the rollup node.
@@ -96,6 +102,7 @@ where
         consensus: C,
         l1_watcher: L1Watcher,
         indexer: Indexer,
+        pipeline: Pipeline,
         forkchoice_state: ForkchoiceState,
         new_block_rx: UnboundedReceiver<NewBlockWithPeer>,
     ) -> Self {
@@ -106,6 +113,7 @@ where
             consensus,
             l1_watcher,
             indexer,
+            pipeline,
             new_block_rx: new_block_rx.into(),
             forkchoice_state,
             pending_block_imports: FuturesOrdered::new(),
@@ -213,7 +221,7 @@ where
 
     /// Handles an L1 event from the L1 watcher.
     fn handle_l1_event(&mut self, _event: L1Event) {
-        todo!();
+        todo!()
     }
 
     /// Handles a block import outcome.
diff --git a/crates/node/src/state.rs b/crates/node/src/state.rs
@@ -0,0 +1,6 @@
+use scroll_engine::ForkchoiceState;
+
+pub struct State {
+    fcs: ForkchoiceState,
+    is_syncing: bool,
+}
diff --git a/crates/pipeline/Cargo.toml b/crates/pipeline/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "pipeline"
+name = "scroll-pipeline"
 version.workspace = true
 edition.workspace = true
 rust-version.workspace = true
diff --git a/crates/pipeline/src/lib.rs b/crates/pipeline/src/lib.rs
@@ -9,15 +9,18 @@ use scroll_primitives::BatchInput;
 pub struct Pipeline;
 
 impl Pipeline {
+    /// Creates a new [`Pipeline`] instance.
     pub fn new() -> Self {
         Pipeline
     }
 
+    /// Handles a batch input.
     pub fn handle_batch_input(&mut self, _batch_input: BatchInput) {
         // Handle the batch input.
         todo!()
     }
 
+    /// Gets the next scroll payload.
     pub fn next(&mut self) -> Option<ScrollPayloadAttributes> {
         // Get the next scroll payload.
         todo!()
diff --git a/crates/primitives/src/batch/mod.rs b/crates/primitives/src/batch/mod.rs
@@ -7,7 +7,7 @@ pub use input::BatchInput;
 /// A batch is the unit of settlement to L1 for the scroll rollup.
 ///
 /// A batch contains a list of chunks, which contain a list of block commitments.
-/// A batch additionally contains metadata related to the unit of settlement.
+/// A batch additionally contains metadata related to the batch.
 #[derive(Debug)]
 pub struct Batch {
     /// The index of the batch.
diff --git a/crates/sequencer/Cargo.toml b/crates/sequencer/Cargo.toml
@@ -14,6 +14,7 @@ scroll-alloy-rpc-types-engine.workspace = true
 reth-scroll-primitives.workspace = true
 
 # rollup-node
+scroll-engine.workspace = true
 scroll-primitives.workspace = true
 
 # misc
diff --git a/crates/sequencer/src/lib.rs b/crates/sequencer/src/lib.rs
@@ -1,25 +1,33 @@
 //! Sequencer is a library that
 use futures::Stream;
-use std::collections::VecDeque;
+use std::{collections::VecDeque, sync::Arc};
 use tokio::time::Interval;
 
 use reth_scroll_primitives::ScrollBlock;
+use scroll_engine::EngineDriver;
 use scroll_primitives::L1Message;
 
 /// The sequencer is responsible for creating new [`ScrollBlock`]s.
 #[derive(Debug)]
-pub struct Sequencer {
+pub struct Sequencer<EC, P> {
     // TODO: Replace with appropriate buffer type that is reorg aware.
     /// A transaction queue for L1 messages.
     tx_queue: VecDeque<L1Message>,
     /// The interval at which the sequencer creates new [`ScrollBlock`]s.
     block_interval: Interval,
+    /// The [`EngineDriver`] that the sequencer uses to interact with the EngineAPI of the
+    /// execution client.
+    engine: Arc<EngineDriver<EC, P>>,
 }
 
-impl Sequencer {
+impl<EC, P> Sequencer<EC, P> {
     /// Creates a new [`Sequencer`] instance.
-    pub fn new(tx_queue: impl IntoIterator<Item = L1Message>, block_interval: Interval) -> Self {
-        Self { tx_queue: tx_queue.into_iter().collect(), block_interval }
+    pub fn new(
+        tx_queue: impl IntoIterator<Item = L1Message>,
+        block_interval: Interval,
+        engine: EngineDriver<EC, P>,
+    ) -> Self {
+        Self { tx_queue: tx_queue.into_iter().collect(), block_interval, engine: Arc::new(engine) }
     }
 
     /// Creates a new [`ScrollBlock`] based on the current state of the sequencer.
@@ -38,7 +46,7 @@ impl Sequencer {
     }
 }
 
-impl Stream for Sequencer {
+impl<EC: Unpin, P: Unpin> Stream for Sequencer<EC, P> {
     type Item = ScrollBlock;
 
     fn poll_next(

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+pub enum CodecError {`
	`2`	`+ Error,`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+mod batch;`
	`2`	`+mod chunk;`
	`3`	`+mod error;`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`/// The configuration of the rollup node.`
`2`	`2`	`#[derive(Debug)]`
`3`	`3`	`pub struct Config {`
	`4`	`+ /// If it is a sequencer node.`
`4`	`5`	`is_sequencer: bool,`
	`6`	`+ /// The block time in milliseconds.`
`5`	`7`	`block_time: u64,`
`6`	`8`	`}`