feat: update scroll consensus (#314)

* feat: block validation

Signed-off-by: Gregory Edison <[email protected]>

* feat: header validation

Signed-off-by: Gregory Edison <[email protected]>

* feat: body validation

Signed-off-by: Gregory Edison <[email protected]>

* feat: withdraw trie root slot (#312)

* feat: update execute_with_state_closure closure

Signed-off-by: Gregory Edison <[email protected]>

* feat: LoadWithdrawRoot

Signed-off-by: Gregory Edison <[email protected]>

* chore: fix clippy docs (paradigmxyz#17726)

Co-authored-by: Alexey Shekhirin <[email protected]>

* fix: clippy

Signed-off-by: Gregory Edison <[email protected]>

---------

Signed-off-by: Gregory Edison <[email protected]>
Co-authored-by: Matthias Seitz <[email protected]>
Co-authored-by: Alexey Shekhirin <[email protected]>

* chore: reorg

Signed-off-by: Gregory Edison <[email protected]>

* feat: answer comment + add unit test

Signed-off-by: Gregory Edison <[email protected]>

* feat: answer comment

Signed-off-by: Gregory Edison <[email protected]>

* feat: check sequential L1 message post EuclidV2

Signed-off-by: Gregory Edison <[email protected]>

---------

Signed-off-by: Gregory Edison <[email protected]>
Co-authored-by: Matthias Seitz <[email protected]>
Co-authored-by: Alexey Shekhirin <[email protected]>
Co-authored-by: frisitano <[email protected]>

Author: 4 people

Cargo.lock

@@ -13,8 +13,8 @@ extern crate alloc as std;
 mod transaction;
 pub use transaction::{
     ScrollAdditionalInfo, ScrollL1MessageTransactionFields, ScrollPooledTransaction,
-    ScrollTransactionInfo, ScrollTxEnvelope, ScrollTxType, ScrollTypedTransaction, TxL1Message,
-    L1_MESSAGE_TRANSACTION_TYPE, L1_MESSAGE_TX_TYPE_ID,
+    ScrollTransaction, ScrollTransactionInfo, ScrollTxEnvelope, ScrollTxType,
+    ScrollTypedTransaction, TxL1Message, L1_MESSAGE_TRANSACTION_TYPE, L1_MESSAGE_TX_TYPE_ID,
 };
 
 mod receipt;

crates/scroll/alloy/consensus/src/lib.rs

@@ -424,6 +424,30 @@ impl ScrollTxEnvelope {
     }
 }
 
+/// A Scroll chain transaction.
+pub trait ScrollTransaction {
+    /// Returns true if the transaction is a L1 message.
+    fn is_l1_message(&self) -> bool;
+    /// Returns the queue index if the transaction is a L1 message, None otherwise.
+    fn queue_index(&self) -> Option<u64>;
+}
+
+impl ScrollTransaction for ScrollTxEnvelope {
+    fn is_l1_message(&self) -> bool {
+        match self {
+            Self::Legacy(_) | Self::Eip2930(_) | Self::Eip1559(_) | Self::Eip7702(_) => false,
+            Self::L1Message(_) => true,
+        }
+    }
+
+    fn queue_index(&self) -> Option<u64> {
+        match self {
+            Self::Legacy(_) | Self::Eip2930(_) | Self::Eip1559(_) | Self::Eip7702(_) => None,
+            Self::L1Message(tx) => Some(tx.queue_index),
+        }
+    }
+}
+
 #[cfg(feature = "reth-codec")]
 impl ToTxCompact for ScrollTxEnvelope {
     fn to_tx_compact(&self, buf: &mut (impl BufMut + AsMut<[u8]>)) {

crates/scroll/alloy/consensus/src/transaction/envelope.rs

@@ -4,7 +4,7 @@ mod tx_type;
 pub use tx_type::{ScrollTxType, L1_MESSAGE_TX_TYPE_ID};
 
 mod envelope;
-pub use envelope::ScrollTxEnvelope;
+pub use envelope::{ScrollTransaction, ScrollTxEnvelope};
 
 mod l1_message;
 pub use l1_message::{ScrollL1MessageTransactionFields, TxL1Message, L1_MESSAGE_TRANSACTION_TYPE};

crates/scroll/alloy/consensus/src/transaction/mod.rs

@@ -14,7 +14,7 @@ workspace = true
 [dependencies]
 # alloy
 alloy-consensus.workspace = true
-alloy-primitives.workspace = true
+alloy-primitives = { workspace = true, features = ["getrandom"] }
 
 # reth
 reth-chainspec.workspace = true
@@ -26,6 +26,7 @@ reth-primitives-traits.workspace = true
 
 # scroll
 reth-scroll-primitives = { workspace = true, default-features = false }
+scroll-alloy-consensus.workspace = true
 scroll-alloy-hardforks.workspace = true
 
 # misc
@@ -34,3 +35,6 @@ tracing.workspace = true
 
 [package.metadata.cargo-udeps.ignore]
 normal = ["reth-primitives"]
+
+[dev-dependencies]
+reth-scroll-chainspec.workspace = true

crates/scroll/consensus/Cargo.toml

@@ -2,3 +2,12 @@ use alloy_primitives::U256;
 
 /// The maximum value Rollup fee.
 pub const MAX_ROLLUP_FEE: U256 = U256::from_limbs([u64::MAX, 0, 0, 0]);
+
+/// The block difficulty for in turn signing in the Clique consensus.
+pub const CLIQUE_IN_TURN_DIFFICULTY: U256 = U256::from_limbs([2, 0, 0, 0]);
+
+/// The block difficulty for out of turn signing in the Clique consensus.
+pub const CLIQUE_NO_TURN_DIFFICULTY: U256 = U256::from_limbs([1, 0, 0, 0]);
+
+/// Maximum allowed base fee. We would only go above this if L1 base fee hits 2931 Gwei.
+pub const SCROLL_MAXIMUM_BASE_FEE: u64 = 10000000000;

crates/scroll/consensus/src/constants.rs

@@ -1,3 +1,6 @@
+use crate::constants::SCROLL_MAXIMUM_BASE_FEE;
+
+use alloy_primitives::{Address, B256, B64, U256};
 use reth_consensus::ConsensusError;
 
 /// Scroll consensus error.
@@ -6,10 +9,55 @@ pub enum ScrollConsensusError {
     /// L1 [`ConsensusError`], that also occurs on L2.
     #[error(transparent)]
     Eth(#[from] ConsensusError),
+    /// Invalid L1 messages order.
+    #[error("invalid L1 message order")]
+    InvalidL1MessageOrder,
+    /// Block has non zero coinbase.
+    #[error("block coinbase not zero: {0}")]
+    CoinbaseNotZero(Address),
+    /// Block has non zero nonce.
+    #[error("block nonce not zero: {0:?}")]
+    NonceNotZero(Option<B64>),
+    /// Block has invalid clique nonce.
+    #[error("block nonce should be 0x0 or 0xffffffffffffffff: {0:?}")]
+    InvalidCliqueNonce(Option<B64>),
+    /// Block has non zero mix hash.
+    #[error("block mix hash not zero: {0:?}")]
+    MixHashNotZero(Option<B256>),
+    /// Block difficulty is not one.
+    #[error("block difficulty not one: {0}")]
+    DifficultyNotOne(U256),
+    /// Block has invalid clique difficulty.
+    #[error("block difficulty should be 1 or 2: {0}")]
+    InvalidCliqueDifficulty(U256),
+    /// Block extra data missing vanity.
+    #[error("block extra data missing vanity")]
+    MissingVanity,
+    /// Block extra data missing signature.
+    #[error("block extra data missing signature")]
+    MissingSignature,
+    /// Block extra data with invalid checkpoint signers.
+    #[error("block extra data contains invalid checkpoint signers")]
+    InvalidCheckpointSigners,
+    /// Block base fee present before Curie.
+    #[error("block base fee is set before Curie fork activation")]
+    UnexpectedBaseFee,
+    /// Block base fee over limit.
+    #[error("block base fee is over limit of {SCROLL_MAXIMUM_BASE_FEE}")]
+    BaseFeeOverLimit,
     /// Block body has non-empty withdrawals list.
     #[error("non-empty block body withdrawals list")]
     WithdrawalsNonEmpty,
     /// Chain spec yielded unexpected blob params.
     #[error("unexpected blob params at timestamp")]
     UnexpectedBlobParams,
 }
+
+impl From<ScrollConsensusError> for ConsensusError {
+    fn from(value: ScrollConsensusError) -> Self {
+        match value {
+            ScrollConsensusError::Eth(eth) => eth,
+            err => Self::Other(err.to_string()),
+        }
+    }
+}

crates/scroll/consensus/src/error.rs

@@ -3,7 +3,9 @@
 extern crate alloc;
 
 mod constants;
-pub use constants::MAX_ROLLUP_FEE;
+pub use constants::{
+    CLIQUE_IN_TURN_DIFFICULTY, CLIQUE_NO_TURN_DIFFICULTY, MAX_ROLLUP_FEE, SCROLL_MAXIMUM_BASE_FEE,
+};
 
 mod error;
 pub use error::ScrollConsensusError;