fix: bitmap (#280)

greged93 · frisitano · web-flow · commit 60f7b7adda53 · 2025-08-28T20:50:45.000+08:00
* feat: use BitVec in place of Vec&lt;u8&gt; for skipped l1 messages bitmap

* test: add test for failing skipped bitmap

* fix lints

* fix lints

---------

Co-authored-by: frisitano &lt;francesco.risitano95@gmail.com&gt;
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -128,11 +128,11 @@ jobs:
           - type: wasm
             target: wasm32-unknown-unknown
             exclude: |
-              scroll-engine,scroll-wire,rollup-node,scroll-network,rollup-node-manager,rollup-node-watcher,scroll-db,scroll-migration,rollup-node-chain-orchestrator,scroll-codec,scroll-derivation-pipeline,rollup-node-providers,rollup-node-sequencer,rollup-node-signer,tests
+              scroll-engine,scroll-wire,rollup-node,scroll-network,rollup-node-manager,rollup-node-watcher,scroll-db,scroll-migration,rollup-node-chain-orchestrator,scroll-codec,scroll-derivation-pipeline,rollup-node-providers,rollup-node-sequencer,rollup-node-signer,scroll-l1,tests
           - type: riscv
             target: riscv32imac-unknown-none-elf
             exclude: |
-              scroll-engine,scroll-wire,rollup-node,scroll-network,rollup-node-manager,rollup-node-watcher,scroll-db,scroll-migration,rollup-node-chain-orchestrator,scroll-codec,scroll-derivation-pipeline,rollup-node-providers,rollup-node-sequencer,rollup-node-signer,tests
+              scroll-engine,scroll-wire,rollup-node,scroll-network,rollup-node-manager,rollup-node-watcher,scroll-db,scroll-migration,rollup-node-chain-orchestrator,scroll-codec,scroll-derivation-pipeline,rollup-node-providers,rollup-node-sequencer,rollup-node-signer,scroll-l1,tests
     steps:
       - uses: actions/checkout@v5
       - uses: rui314/setup-mold@v1
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -189,6 +189,7 @@ scroll-migration = { path = "crates/database/migration" }
 arbitrary = { version = "1.4", default-features = false }
 async-trait = "0.1"
 auto_impl = "1.2"
+bitvec = { version = "1.0", default-features = false }
 clap = { version = "4", features = ["derive", "env"] }
 derive_more = { version = "2.0", default-features = false }
 eyre = "0.6"
diff --git a/crates/codec/Cargo.toml b/crates/codec/Cargo.toml
@@ -15,6 +15,7 @@ alloy-sol-types.workspace = true
 scroll-l1.workspace = true
 
 # misc
+bitvec.workspace = true
 derive_more = { version = "2.0", default-features = false }
 eyre = { workspace = true, optional = true }
 thiserror = { version = "2.0", default-features = false }
diff --git a/crates/codec/src/decoding/payload.rs b/crates/codec/src/decoding/payload.rs
@@ -2,6 +2,7 @@
 
 use crate::L2Block;
 use alloy_primitives::B256;
+use bitvec::vec::BitVec;
 use std::vec::Vec;
 
 /// The payload data on the L1.
@@ -12,7 +13,7 @@ pub struct PayloadData {
     /// Contains information about the current state of the L1 message queue.
     pub l1_message_queue_info: L1MessageQueueInfo,
     /// Contains the skipped L1 message bitmap if present.
-    pub skipped_l1_message_bitmap: Option<Vec<u8>>,
+    pub skipped_l1_message_bitmap: Option<BitVec>,
 }
 
 /// Information about the state of the L1 message queue.
diff --git a/crates/codec/src/decoding/v0/mod.rs b/crates/codec/src/decoding/v0/mod.rs
@@ -64,7 +64,7 @@ pub fn decode_v0(calldata: &[u8]) -> Result<Batch, DecodingError> {
     let payload = PayloadData {
         blocks: l2_blocks,
         l1_message_queue_info: l1_message_start_index.into(),
-        skipped_l1_message_bitmap: call.skipped_l1_message_bitmap(),
+        skipped_l1_message_bitmap: call.skipped_l1_message_bitmap()?,
     };
 
     Ok(Batch::new(call.version(), Some(chunks_block_count), payload))
diff --git a/crates/codec/src/decoding/v1/mod.rs b/crates/codec/src/decoding/v1/mod.rs
@@ -13,6 +13,7 @@ use crate::{
 use std::vec::Vec;
 
 use alloy_primitives::bytes::Buf;
+use bitvec::vec::BitVec;
 use scroll_l1::abi::calls::CommitBatchCall;
 
 /// The max amount of chunks per batch for V1 codec.
@@ -54,7 +55,7 @@ pub fn decode_v1(calldata: &[u8], blob: &[u8]) -> Result<Batch, DecodingError> {
 
     decode_v1_chunk(
         call.version(),
-        call.skipped_l1_message_bitmap(),
+        call.skipped_l1_message_bitmap()?,
         l1_message_start_index,
         chunks,
         buf,
@@ -64,7 +65,7 @@ pub fn decode_v1(calldata: &[u8], blob: &[u8]) -> Result<Batch, DecodingError> {
 /// Decode the provided chunks and blob data into [`L2Block`].
 pub(crate) fn decode_v1_chunk(
     version: u8,
-    skipped_l1_message_bitmap: Option<Vec<u8>>,
+    skipped_l1_message_bitmap: Option<BitVec>,
     l1_message_start_index: u64,
     chunks: Vec<&[u8]>,
     blob: &[u8],
diff --git a/crates/codec/src/decoding/v2/mod.rs b/crates/codec/src/decoding/v2/mod.rs
@@ -52,7 +52,7 @@ pub fn decode_v2(calldata: &[u8], blob: &[u8]) -> Result<Batch, DecodingError> {
 
     decode_v1_chunk(
         call.version(),
-        call.skipped_l1_message_bitmap(),
+        call.skipped_l1_message_bitmap()?,
         l1_message_start_index,
         chunks,
         buf,
diff --git a/crates/codec/src/decoding/v4/mod.rs b/crates/codec/src/decoding/v4/mod.rs
@@ -48,7 +48,7 @@ pub fn decode_v4(calldata: &[u8], blob: &[u8]) -> Result<Batch, DecodingError> {
 
     decode_v1_chunk(
         call.version(),
-        call.skipped_l1_message_bitmap(),
+        call.skipped_l1_message_bitmap()?,
         l1_message_start_index,
         chunks,
         buf,
diff --git a/crates/codec/src/error.rs b/crates/codec/src/error.rs
@@ -1,4 +1,5 @@
 use alloy_primitives::U256;
+use scroll_l1::abi::calls::InvalidCommitBatchCall;
 
 /// An error occurring during the codec process.
 #[derive(Debug, thiserror::Error)]
@@ -27,6 +28,8 @@ pub enum DecodingError {
     InvalidCalldataFormat,
     #[error("invalid parent header format")]
     InvalidParentHeaderFormat,
+    #[error(transparent)]
+    InvalidCommitBatchCall(#[from] InvalidCommitBatchCall),
     #[error("end of file")]
     Eof,
     #[error("decoding error occurred: {0}")]
diff --git a/crates/derivation-pipeline/src/lib.rs b/crates/derivation-pipeline/src/lib.rs
@@ -277,7 +277,7 @@ pub async fn derive<L1P: L1Provider + Sync + Send, L2P: BlockDataProvider + Sync
         let mut txs = Vec::with_capacity(block.context.num_transactions as usize);
         for _ in 0..block.context.num_l1_messages {
             // check if the next l1 message should be skipped.
-            if matches!(skipped_l1_messages.next(), Some(bit) if bit == 1) {
+            if matches!(skipped_l1_messages.next(), Some(bit) if bit) {
                 l1_provider.increment_cursor();
                 continue;
             }
@@ -713,6 +713,64 @@ mod tests {
         Ok(())
     }
 
+    #[tokio::test]
+    async fn test_should_skip_l1_messages_complex() -> eyre::Result<()> {
+        // https://sepolia.etherscan.io/tx/0x3ac4fa531bba0cd1593e2f5e6720a6c580864665d50fbf0de4ca9d7de10c504b
+        // load batch data in the db.
+        let db = Arc::new(setup_test_db().await);
+        let raw_calldata =
+            read_to_bytes("./testdata/calldata_v0_with_skipped_l1_messages_complex.bin")?;
+        let batch_data = BatchCommitData {
+            hash: b256!("082A1232491ACFBB436BF37E788967773DDF3B40E0F60170355870868E45FD7F"),
+            index: 38265,
+            block_number: 4373247,
+            block_timestamp: 1695797868,
+            calldata: Arc::new(raw_calldata),
+            blob_versioned_hash: None,
+            finalized_block_number: None,
+        };
+
+        // prepare the l1 messages.
+        let l1_messages = (777290..=777306)
+            .map(|index| L1MessageEnvelope {
+                l1_block_number: 0,
+                l2_block_number: None,
+                queue_hash: None,
+                transaction: TxL1Message { queue_index: index, ..Default::default() },
+            })
+            .collect::<Vec<_>>();
+
+        for message in l1_messages.clone() {
+            db.insert_l1_message(message).await?;
+        }
+
+        let l1_messages_provider = DatabaseL1MessageProvider::new(db.clone(), 0);
+        let l1_provider = MockL1Provider { l1_messages_provider, blobs: HashMap::new() };
+        let l2_provider = MockL2Provider;
+
+        // derive attributes and extract l1 messages.
+        let attributes: Vec<_> = derive(batch_data, l1_provider, l2_provider).await?;
+        let derived_l1_messages: Vec<_> = attributes
+            .into_iter()
+            .filter_map(|a| a.transactions)
+            .flatten()
+            .filter_map(|rlp| {
+                let buf = &mut rlp.as_ref();
+                TxL1Message::decode_2718(buf).ok()
+            })
+            .collect();
+
+        // skipped bitmap should be [0, 1, 0, 1, 0, 1, 0, 1], [0, 1, 0, 1, 0, 1, 0, 1], [0..0], ..
+        // meaning every second message is skipped.
+        let expected_l1_messages: Vec<_> = l1_messages
+            .into_iter()
+            .enumerate()
+            .filter_map(|(index, message)| (index % 2 == 0).then_some(message.transaction))
+            .collect();
+        assert_eq!(expected_l1_messages, derived_l1_messages);
+        Ok(())
+    }
+
     #[test]
     #[allow(clippy::large_stack_frames)]
     fn test_should_derive_blob_batch() -> eyre::Result<()> {
diff --git a/crates/derivation-pipeline/testdata/calldata_v0_with_skipped_l1_messages_complex.bin b/crates/derivation-pipeline/testdata/calldata_v0_with_skipped_l1_messages_complex.bin
diff --git a/crates/l1/Cargo.toml b/crates/l1/Cargo.toml
@@ -19,9 +19,17 @@ scroll-alloy-consensus.workspace = true
 
 # misc
 arbitrary = { workspace = true, optional = true, features = ["derive"] }
+bitvec = { workspace = true, features = ["alloc"] }
 derive_more.workspace = true
+thiserror.workspace = true
 
 [features]
 default = ["std"]
-std = ["alloy-primitives/std", "scroll-alloy-consensus/std", "alloy-sol-types/std", "derive_more/std"]
+std = [
+    "alloy-primitives/std",
+    "scroll-alloy-consensus/std",
+    "alloy-sol-types/std",
+    "derive_more/std",
+    "bitvec/std",
+]
 test-utils = ["std", "dep:arbitrary", "alloy-primitives/arbitrary"]
diff --git a/crates/l1/src/abi/calls.rs b/crates/l1/src/abi/calls.rs
@@ -1,6 +1,7 @@
 use std::vec::Vec;
 
 use alloy_sol_types::{sol, SolCall};
+use bitvec::vec::BitVec;
 
 sol! {
     #[cfg_attr(feature = "test-utils", derive(arbitrary::Arbitrary))]
@@ -31,6 +32,14 @@ sol! {
     ) external;
 }
 
+/// Encountered an invalid commit batch call.
+#[derive(Debug, thiserror::Error)]
+pub enum InvalidCommitBatchCall {
+    /// The skipped L1 message bitmap is malformed.
+    #[error("invalid skipped L1 message bitmap length: {0}")]
+    InvalidSkippedL1MessageBitmapLength(usize),
+}
+
 /// A call to commit a batch on the L1 Scroll Rollup contract.
 #[derive(Debug, derive_more::From)]
 pub enum CommitBatchCall {
@@ -88,14 +97,26 @@ impl CommitBatchCall {
     }
 
     /// Returns the skipped L1 message bitmap for the commit call if any, returns None otherwise.
-    pub fn skipped_l1_message_bitmap(&self) -> Option<Vec<u8>> {
+    pub fn skipped_l1_message_bitmap(&self) -> Result<Option<BitVec>, InvalidCommitBatchCall> {
         let bitmap = match self {
             Self::CommitBatch(b) => &b.skipped_l1_message_bitmap,
             Self::CommitBatchWithBlobProof(b) => &b.skipped_l1_message_bitmap,
-            Self::CommitBatches(_) => return None,
+            Self::CommitBatches(_) => return Ok(None),
         };
-        let mut bitmap = bitmap.to_vec();
-        bitmap.reverse();
-        Some(bitmap)
+        if bitmap.len() % 32 != 0 {
+            return Err(InvalidCommitBatchCall::InvalidSkippedL1MessageBitmapLength(bitmap.len()));
+        }
+
+        let mut bitvec = BitVec::with_capacity(bitmap.len() * 8);
+
+        // the `skipped_l1_message_bitmap` field is read in little-endian order, so we need to
+        // reverse the bytes before pushing them to the bitvec.
+        for bytes in bitmap.into_iter().rev() {
+            for i in 0u8..8 {
+                bitvec.push((bytes >> i) & 1 == 1);
+            }
+        }
+
+        Ok(Some(bitvec))
     }
 }
