feat: scroll l1 message transaction (#41)

* implement Scroll l1 message transaction Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> * add scroll l1 message transaction to `Transaction` enum Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> * propagate scroll feature flag in optimism crates for conditional compilation Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> * nit fixes Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> * fix lints Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> * rebasing changes Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> * move `L1_MESSAGE_TRANSACTION_TYPE` to reth_scroll_primitives Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> * feature gate Compact derive Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> * fix lints Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> * reformat manifest Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> * fix: answer comments Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com> --------- Signed-off-by: Gregory Edison <gregory.edison1993@gmail.com>
scroll-tech · Nov 28, 2024 · 1c9ebaf · 1c9ebaf
1 parent 9730a0f
commit 1c9ebaf
Show file tree

Hide file tree

Showing 29 changed files with 768 additions and 160 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/optimism/bin/src/lib.rs b/crates/optimism/bin/src/lib.rs
@@ -24,11 +24,9 @@
     issue_tracker_base_url = "https://github.com/paradigmxyz/reth/issues/"
 )]
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
-// The `optimism` feature must be enabled to use this crate.
-#![cfg(feature = "optimism")]
-// Don't use the crate if `scroll` feature is used.
 #![cfg_attr(feature = "scroll", allow(unused_crate_dependencies))]
-#![cfg(not(feature = "scroll"))]
+// The `optimism` feature must be enabled to use this crate.
+#![cfg(all(feature = "optimism", not(feature = "scroll")))]
 
 /// Re-exported from `reth_optimism_cli`.
 pub mod cli {

diff --git a/crates/optimism/bin/src/main.rs b/crates/optimism/bin/src/main.rs
@@ -1,9 +1,7 @@
 #![allow(missing_docs, rustdoc::missing_crate_level_docs)]
-// The `optimism` feature must be enabled to use this crate.
-#![cfg(feature = "optimism")]
-// Don't use the crate if `scroll` feature is used.
 #![cfg_attr(feature = "scroll", allow(unused_crate_dependencies))]
-#![cfg(not(feature = "scroll"))]
+// The `optimism` feature must be enabled to use this crate.
+#![cfg(all(feature = "optimism", not(feature = "scroll")))]
 
 use clap::Parser;
 use reth_node_builder::{engine_tree_config::TreeConfig, EngineNodeLauncher};

diff --git a/crates/optimism/cli/src/lib.rs b/crates/optimism/cli/src/lib.rs
@@ -7,11 +7,9 @@
 )]
 #![cfg_attr(all(not(test), feature = "optimism"), warn(unused_crate_dependencies))]
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
-// The `optimism` feature must be enabled to use this crate.
-#![cfg(feature = "optimism")]
-// Don't use the crate if `scroll` feature is used.
 #![cfg_attr(feature = "scroll", allow(unused_crate_dependencies))]
-#![cfg(not(feature = "scroll"))]
+// The `optimism` feature must be enabled to use this crate.
+#![cfg(all(feature = "optimism", not(feature = "scroll")))]
 
 /// Optimism chain specification parser.
 pub mod chainspec;

diff --git a/crates/optimism/consensus/Cargo.toml b/crates/optimism/consensus/Cargo.toml
@@ -36,3 +36,4 @@ reth-optimism-chainspec.workspace = true
 
 [features]
 optimism = ["reth-primitives/optimism"]
+scroll = []
diff --git a/crates/optimism/consensus/src/lib.rs b/crates/optimism/consensus/src/lib.rs
@@ -6,8 +6,9 @@
     issue_tracker_base_url = "https://github.com/paradigmxyz/reth/issues/"
 )]
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(feature = "scroll", allow(unused_crate_dependencies))]
 // The `optimism` feature must be enabled to use this crate.
-#![cfg(feature = "optimism")]
+#![cfg(all(feature = "optimism", not(feature = "scroll")))]
 
 use alloy_consensus::{Header, EMPTY_OMMER_ROOT_HASH};
 use alloy_primitives::{B64, U256};

diff --git a/crates/optimism/evm/src/lib.rs b/crates/optimism/evm/src/lib.rs
@@ -7,11 +7,9 @@
 )]
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![cfg_attr(not(feature = "std"), no_std)]
-// The `optimism` feature must be enabled to use this crate.
-#![cfg(feature = "optimism")]
-// Don't use the crate if `scroll` feature is used.
 #![cfg_attr(feature = "scroll", allow(unused_crate_dependencies))]
-#![cfg(not(feature = "scroll"))]
+// The `optimism` feature must be enabled to use this crate.
+#![cfg(all(feature = "optimism", not(feature = "scroll")))]
 
 extern crate alloc;
 

diff --git a/crates/optimism/node/src/lib.rs b/crates/optimism/node/src/lib.rs
@@ -6,11 +6,9 @@
     issue_tracker_base_url = "https://github.com/paradigmxyz/reth/issues/"
 )]
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
-// The `optimism` feature must be enabled to use this crate.
-#![cfg(feature = "optimism")]
-// Don't use the crate if `scroll` feature is used.
 #![cfg_attr(feature = "scroll", allow(unused_crate_dependencies))]
-#![cfg(not(feature = "scroll"))]
+// The `optimism` feature must be enabled to use this crate.
+#![cfg(all(feature = "optimism", not(feature = "scroll")))]
 
 /// CLI argument parsing for the optimism node.
 pub mod args;

diff --git a/crates/optimism/node/tests/e2e/main.rs b/crates/optimism/node/tests/e2e/main.rs
@@ -3,7 +3,7 @@
 #![cfg_attr(feature = "scroll", allow(unused_crate_dependencies))]
 #![cfg(not(feature = "scroll"))]
 
-#[cfg(feature = "optimism")]
+#[cfg(all(feature = "optimism", not(feature = "scroll")))]
 mod p2p;
 
 const fn main() {}
diff --git a/crates/optimism/node/tests/it/main.rs b/crates/optimism/node/tests/it/main.rs
@@ -3,10 +3,10 @@
 #![cfg_attr(feature = "scroll", allow(unused_crate_dependencies))]
 #![cfg(not(feature = "scroll"))]
 
-#[cfg(feature = "optimism")]
+#[cfg(all(feature = "optimism", not(feature = "scroll")))]
 mod builder;
 
-#[cfg(feature = "optimism")]
+#[cfg(all(feature = "optimism", not(feature = "scroll")))]
 mod priority;
 
 const fn main() {}
diff --git a/crates/optimism/payload/src/lib.rs b/crates/optimism/payload/src/lib.rs
@@ -8,11 +8,9 @@
 #![cfg_attr(all(not(test), feature = "optimism"), warn(unused_crate_dependencies))]
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![allow(clippy::useless_let_if_seq)]
-// The `optimism` feature must be enabled to use this crate.
-#![cfg(feature = "optimism")]
-// Don't use the crate if `scroll` feature is used.
 #![cfg_attr(feature = "scroll", allow(unused_crate_dependencies))]
-#![cfg(not(feature = "scroll"))]
+// The `optimism` feature must be enabled to use this crate.
+#![cfg(all(feature = "optimism", not(feature = "scroll")))]
 
 pub mod builder;
 pub use builder::OpPayloadBuilder;

diff --git a/crates/optimism/rpc/src/lib.rs b/crates/optimism/rpc/src/lib.rs
@@ -7,11 +7,9 @@
 )]
 #![cfg_attr(all(not(test), feature = "optimism"), warn(unused_crate_dependencies))]
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
-// The `optimism` feature must be enabled to use this crate.
-#![cfg(feature = "optimism")]
-// Don't use the crate if `scroll` feature is used.
 #![cfg_attr(feature = "scroll", allow(unused_crate_dependencies))]
-#![cfg(not(feature = "scroll"))]
+// The `optimism` feature must be enabled to use this crate.
+#![cfg(all(feature = "optimism", not(feature = "scroll")))]
 
 pub mod error;
 pub mod eth;

diff --git a/crates/primitives-traits/Cargo.toml b/crates/primitives-traits/Cargo.toml
@@ -97,9 +97,9 @@ serde = [
     "bytes/serde",
     "rand/serde",
     "reth-codecs?/serde",
-    "revm-primitives/serde",
     "roaring/serde",
 	"revm-primitives/serde",
+	"reth-scroll-primitives?/serde"
 ]
 reth-codec = [
 	"dep:reth-codecs",

diff --git a/crates/primitives/Cargo.toml b/crates/primitives/Cargo.toml
@@ -30,6 +30,7 @@ alloy-trie = { workspace = true, features = ["serde"] }
 
 # scroll
 revm-primitives = { package = "reth-scroll-revm", path = "../scroll/revm", features = ["serde"] }
+reth-scroll-primitives = { workspace = true, optional = true, features = ["serde"] }
 
 # optimism
 op-alloy-rpc-types = { workspace = true, optional = true }
@@ -132,7 +133,8 @@ arbitrary = [
 	"op-alloy-rpc-types?/arbitrary",
 	"reth-codecs?/arbitrary",
 	"alloy-trie/arbitrary",
-	"reth-trie-common/arbitrary"
+	"reth-trie-common/arbitrary",
+	"reth-scroll-primitives?/arbitrary"
 ]
 secp256k1 = ["dep:secp256k1"]
 c-kzg = [
@@ -170,7 +172,8 @@ serde-bincode-compat = [
 scroll = [
 	"reth-trie-common/scroll",
 	"reth-primitives-traits/scroll",
-	"reth-testing-utils/scroll"
+	"reth-testing-utils/scroll",
+	"reth-scroll-primitives"
 ]
 
 [[bench]]

diff --git a/crates/primitives/src/alloy_compat.rs b/crates/primitives/src/alloy_compat.rs
@@ -123,34 +123,64 @@ impl TryFrom<AnyRpcTransaction> for TransactionSigned {
                 let (tx, signature, hash) = tx.into_parts();
                 (Transaction::Eip7702(tx), signature, hash)
             }
-            #[cfg(feature = "optimism")]
-            AnyTxEnvelope::Unknown(alloy_network::UnknownTxEnvelope { hash, inner }) => {
+            #[cfg(any(feature = "optimism", feature = "scroll"))]
+            AnyTxEnvelope::Unknown(alloy_network::UnknownTxEnvelope { hash: _hash, inner }) => {
                 use alloy_consensus::Transaction as _;
 
-                if inner.ty() == crate::TxType::Deposit {
-                    let fields: op_alloy_rpc_types::OpTransactionFields = inner
-                        .fields
-                        .clone()
-                        .deserialize_into::<op_alloy_rpc_types::OpTransactionFields>()
-                        .map_err(|e| ConversionError::Custom(e.to_string()))?;
-                    (
-                        Transaction::Deposit(op_alloy_consensus::TxDeposit {
-                            source_hash: fields.source_hash.ok_or_else(|| {
-                                ConversionError::Custom("MissingSourceHash".to_string())
-                            })?,
-                            from: tx.from,
-                            to: revm_primitives::TxKind::from(inner.to()),
-                            mint: fields.mint.filter(|n| *n != 0),
-                            value: inner.value(),
-                            gas_limit: inner.gas_limit(),
-                            is_system_transaction: fields.is_system_tx.unwrap_or(false),
-                            input: inner.input().clone(),
-                        }),
-                        op_alloy_consensus::TxDeposit::signature(),
-                        hash,
-                    )
-                } else {
-                    return Err(ConversionError::Custom("unknown transaction type".to_string()))
+                match TryInto::<crate::TxType>::try_into(inner.ty())
+                    .map_err(|e| ConversionError::Custom(e.to_string()))?
+                {
+                    #[cfg(all(feature = "optimism", not(feature = "scroll")))]
+                    crate::TxType::Deposit => {
+                        let fields: op_alloy_rpc_types::OpTransactionFields = inner
+                            .fields
+                            .clone()
+                            .deserialize_into::<op_alloy_rpc_types::OpTransactionFields>()
+                            .map_err(|e| ConversionError::Custom(e.to_string()))?;
+                        (
+                            Transaction::Deposit(op_alloy_consensus::TxDeposit {
+                                source_hash: fields.source_hash.ok_or_else(|| {
+                                    ConversionError::Custom("MissingSourceHash".to_string())
+                                })?,
+                                from: tx.from,
+                                to: revm_primitives::TxKind::from(inner.to()),
+                                mint: fields.mint.filter(|n| *n != 0),
+                                value: inner.value(),
+                                gas_limit: inner.gas_limit(),
+                                is_system_transaction: fields.is_system_tx.unwrap_or(false),
+                                input: inner.input().clone(),
+                            }),
+                            op_alloy_consensus::TxDeposit::signature(),
+                            _hash,
+                        )
+                    }
+                    #[cfg(all(feature = "scroll", not(feature = "optimism")))]
+                    crate::TxType::L1Message => {
+                        let fields =
+                            inner
+                                .fields
+                                .clone()
+                                .deserialize_into::<reth_scroll_primitives::ScrollL1MessageTransactionFields>()
+                                .map_err(|e| ConversionError::Custom(e.to_string()))?;
+                        (
+                            Transaction::L1Message(reth_scroll_primitives::TxL1Message {
+                                queue_index: fields.queue_index,
+                                gas_limit: inner.gas_limit(),
+                                to: inner.to().ok_or(ConversionError::Custom(
+                                    "Scroll L1 message transaction do not support create transaction"
+                                        .to_string(),
+                                ))?,
+                                value: inner.value(),
+                                sender: fields.sender,
+                                input: inner.input().clone(),
+                            }),
+                            reth_scroll_primitives::TxL1Message::signature(),
+                            _hash,
+                        )
+                    }
+                    _ => {
+                        return Err(ConversionError::Custom("unknown transaction type".to_string()))
+                    }
                 }
             }
             _ => return Err(ConversionError::Custom("unknown transaction type".to_string())),
@@ -161,7 +191,7 @@ impl TryFrom<AnyRpcTransaction> for TransactionSigned {
 }
 
 #[cfg(test)]
-#[cfg(feature = "optimism")]
+#[cfg(all(feature = "optimism", not(feature = "scroll")))]
 mod tests {
     use super::*;
     use alloy_primitives::{address, Address, B256, U256};
@@ -270,3 +300,48 @@ mod tests {
         }
     }
 }
+
+#[cfg(test)]
+#[cfg(all(feature = "scroll", not(feature = "optimism")))]
+mod tests {
+    use super::*;
+    use alloy_primitives::{address, U256};
+
+    #[test]
+    fn test_scroll_l1_message_tx() {
+        // https://scrollscan.com/tx/0x36199419dbdb7823235de4b73e3d90a61c7b1f343b7a682a271c3055249e81f9
+        let input = r#"{
+            "hash":"0x36199419dbdb7823235de4b73e3d90a61c7b1f343b7a682a271c3055249e81f9",
+            "nonce":"0x0",
+            "blockHash":"0x4aca26460c31be3948e8466681ad87891326a964422c9370d4c1913f3bed4b10",
+            "blockNumber":"0xabf06f",
+            "transactionIndex":"0x0",
+            "from":"0x7885bcbd5cecef1336b5300fb5186a12ddd8c478",
+            "to":"0x781e90f1c8fc4611c9b7497c3b47f99ef6969cbc",
+            "value":"0x0",
+            "gasPrice":"0x0",
+            "gas":"0x1e8480",
+            "input":"0x8ef1332e000000000000000000000000c186fa914353c44b2e33ebe05f21846f1048beda0000000000000000000000003bad7ad0728f9917d1bf08af5782dcbd516cdd96000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000e76ab00000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000044493a4f84f464e58d4bfa93bcc57abfb14dbe1b8ff46cd132b5709aab227f269727943d2f000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
+            "r":"0x0",
+            "s":"0x0",
+            "v":"0x0",
+            "type":"0x7e",
+            "queueIndex":"0xe76ab",
+            "sender":"0x7885bcbd5cecef1336b5300fb5186a12ddd8c478"
+        }"#;
+        let alloy_tx: WithOtherFields<alloy_rpc_types::Transaction<AnyTxEnvelope>> =
+            serde_json::from_str(input).expect("failed to deserialize");
+
+        let TransactionSigned { transaction: reth_tx, .. } =
+            alloy_tx.try_into().expect("failed to convert");
+        if let Transaction::L1Message(l1_message_tx) = reth_tx {
+            assert_eq!(l1_message_tx.queue_index, 0xe76ab);
+            assert_eq!(l1_message_tx.gas_limit, 0x1e8480);
+            assert_eq!(l1_message_tx.to, address!("781e90f1c8fc4611c9b7497c3b47f99ef6969cbc"));
+            assert_eq!(l1_message_tx.value, U256::ZERO);
+            assert_eq!(l1_message_tx.sender, address!("7885bcbd5cecef1336b5300fb5186a12ddd8c478"));
+        } else {
+            panic!("Expected L1 message transaction");
+        }
+    }
+}
diff --git a/crates/primitives/src/lib.rs b/crates/primitives/src/lib.rs
@@ -19,6 +19,11 @@
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![cfg_attr(not(feature = "std"), no_std)]
 
+#[cfg(feature = "optimism")]
+use op_alloy_consensus as _;
+#[cfg(feature = "scroll")]
+use reth_scroll_primitives as _;
+
 extern crate alloc;
 
 #[cfg(feature = "alloy-compat")]
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,3 +36,4 @@ reth-optimism-chainspec.workspace = true

		[features]
		optimism = ["reth-primitives/optimism"]
		scroll = []