chore(rpc): decouple op receipt response

Cargo.toml

@@ -55,6 +55,7 @@ members = [
     "crates/optimism/evm/",
     "crates/optimism/node/",
     "crates/optimism/payload/",
+    "crates/optimism/rpc",
     "crates/node-core/",
     "crates/node/api/",
     "crates/stages/",
@@ -278,6 +279,7 @@ reth-transaction-pool = { path = "crates/transaction-pool" }
 reth-trie = { path = "crates/trie" }
 reth-trie-parallel = { path = "crates/trie-parallel" }
 reth-optimism-consensus = { path = "crates/optimism/consensus" }
+reth-optimism-rpc = { path = "crates/optimism/rpc" }
 reth-node-events = { path = "crates/node/events" }
 reth-testing-utils = { path = "testing/testing-utils" }
 
@@ -297,7 +299,7 @@ alloy-primitives = "0.7.2"
 alloy-dyn-abi = "0.7.2"
 alloy-sol-types = "0.7.2"
 alloy-rlp = "0.3.4"
-alloy-trie = "0.4.0"
+alloy-trie = "0.4"
 alloy-rpc-types = { git = "https://github.com/alloy-rs/alloy", rev = "64feb9b" }
 alloy-rpc-types-anvil = { git = "https://github.com/alloy-rs/alloy", rev = "64feb9b" }
 alloy-rpc-types-trace = { git = "https://github.com/alloy-rs/alloy", rev = "64feb9b" }

crates/optimism/rpc/Cargo.toml

@@ -0,0 +1,31 @@
+[package]
+name = "reth-optimism-rpc"
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+homepage.workspace = true
+repository.workspace = true
+description = "An extension of ethereum RPC for optimism."
+
+[lints]
+workspace = true
+
+[dependencies]
+# reth
+reth-evm.workspace = true
+reth-evm-optimism = { workspace = true, features = ["optimism"] }
+revm.workspace = true
+reth-network-api.workspace = true
+reth-rpc = { workspace = true, features = ["optimism"] }
+reth-rpc-api.workspace = true
+reth-rpc-types.workspace = true
+reth-primitives = { workspace = true, features = ["optimism"] }
+reth-provider.workspace = true
+reth-transaction-pool.workspace = true
+
+# rpc
+jsonrpsee.workspace = true
+
+# misc
+thiserror.workspace = true

crates/rpc/rpc/src/eth/optimism.rs → crates/optimism/rpc/src/error.rs

@@ -1,12 +1,10 @@
-//! Optimism specific types.
+//! RPC errors specific to OP.
 
 use jsonrpsee::types::ErrorObject;
+use reth_rpc::{eth::error::EthApiError, result::internal_rpc_err};
 use reth_rpc_types::ToRpcError;
 
-use crate::{eth::error::EthApiError, result::internal_rpc_err};
-
 /// Eth Optimism Api Error
-#[cfg(feature = "optimism")]
 #[derive(Debug, thiserror::Error)]
 pub enum OptimismEthApiError {
     /// Thrown when calculating L1 gas fee

crates/optimism/rpc/src/lib.rs

@@ -0,0 +1,4 @@
+//! Optimism RPC extension.
+
+pub mod error;
+pub mod receipts;

crates/optimism/rpc/src/receipts.rs

@@ -0,0 +1,192 @@
+//! Formats OP receipt RPC responses.   
+
+use reth_evm::ConfigureEvm;
+use reth_evm_optimism::RethL1BlockInfo;
+use reth_network_api::NetworkInfo;
+use reth_primitives::{BlockId, Receipt, TransactionMeta, TransactionSigned};
+use reth_provider::{BlockReaderIdExt, ChainSpecProvider, EvmEnvProvider, StateProviderFactory};
+use reth_rpc::{
+    eth::{
+        api::transactions::ReceiptResponseBuilder,
+        error::{EthApiError, EthResult},
+    },
+    EthApi,
+};
+use reth_rpc_types::{AnyTransactionReceipt, OptimismTransactionReceiptFields};
+use reth_transaction_pool::TransactionPool;
+use revm::L1BlockInfo;
+
+use crate::error::OptimismEthApiError;
+
+/// Helper function for `eth_getBlockReceipts`. Returns all transaction receipts in the block.
+///
+/// Returns `None` if the block wasn't found.
+pub async fn block_receipts<Provider, Pool, Network, EvmConfig>(
+    eth_api: &EthApi<Provider, Pool, Network, EvmConfig>,
+    block_id: BlockId,
+) -> EthResult<Option<Vec<AnyTransactionReceipt>>>
+where
+    Provider:
+        BlockReaderIdExt + ChainSpecProvider + EvmEnvProvider + StateProviderFactory + 'static,
+    Pool: TransactionPool + 'static,
+    Network: NetworkInfo + 'static,
+    EvmConfig: ConfigureEvm + 'static,
+{
+    if let Some((block, receipts)) = eth_api.load_block_and_receipts(block_id).await? {
+        let block_number = block.number;
+        let base_fee = block.base_fee_per_gas;
+        let block_hash = block.hash();
+        let excess_blob_gas = block.excess_blob_gas;
+        let timestamp = block.timestamp;
+        let block = block.unseal();
+
+        let l1_block_info = reth_evm_optimism::extract_l1_info(&block).ok();
+
+        let receipts = block
+            .body
+            .into_iter()
+            .zip(receipts.iter())
+            .enumerate()
+            .map(|(idx, (ref tx, receipt))| {
+                let meta = TransactionMeta {
+                    tx_hash: tx.hash,
+                    index: idx as u64,
+                    block_hash,
+                    block_number,
+                    base_fee,
+                    excess_blob_gas,
+                    timestamp,
+                };
+
+                let optimism_tx_meta =
+                    build_op_tx_meta(eth_api, tx, l1_block_info.clone(), timestamp)?;
+
+                ReceiptResponseBuilder::new(tx, meta, receipt, &receipts)
+                    .map(|builder| op_fields(builder, tx, receipt, optimism_tx_meta).build())
+            })
+            .collect::<EthResult<Vec<_>>>();
+        return receipts.map(Some)
+    }
+
+    Ok(None)
+}
+
+/// Helper function for `eth_getTransactionReceipt`
+///
+/// Returns the receipt
+pub async fn build_transaction_receipt<Provider, Pool, Network, EvmConfig>(
+    eth_api: &EthApi<Provider, Pool, Network, EvmConfig>,
+    tx: TransactionSigned,
+    meta: TransactionMeta,
+    receipt: Receipt,
+) -> EthResult<AnyTransactionReceipt>
+where
+    Provider: BlockReaderIdExt + ChainSpecProvider,
+{
+    let (block, receipts) = eth_api
+        .cache()
+        .get_block_and_receipts(meta.block_hash)
+        .await?
+        .ok_or(EthApiError::UnknownBlockNumber)?;
+
+    let block = block.unseal();
+    let l1_block_info = reth_evm_optimism::extract_l1_info(&block).ok();
+    let optimism_tx_meta = build_op_tx_meta(eth_api, &tx, l1_block_info, block.timestamp)?;
+
+    let resp_builder = ReceiptResponseBuilder::new(&tx, meta, &receipt, &receipts)?;
+    let resp_builder = op_fields(resp_builder, &tx, &receipt, optimism_tx_meta);
+
+    Ok(resp_builder.build())
+}
+
+/// Builds op metadata object using the provided [TransactionSigned], L1 block info and
+/// `block_timestamp`. The L1BlockInfo is used to calculate the l1 fee and l1 data gas for the
+/// transaction. If the L1BlockInfo is not provided, the meta info will be empty.
+pub fn build_op_tx_meta<Provider, Pool, Network, EvmConfig>(
+    eth_api: &EthApi<Provider, Pool, Network, EvmConfig>,
+    tx: &TransactionSigned,
+    l1_block_info: Option<revm::L1BlockInfo>,
+    block_timestamp: u64,
+) -> EthResult<OptimismTxMeta>
+where
+    Provider: BlockReaderIdExt + ChainSpecProvider,
+{
+    let Some(l1_block_info) = l1_block_info else { return Ok(OptimismTxMeta::default()) };
+
+    let (l1_fee, l1_data_gas) = if !tx.is_deposit() {
+        let envelope_buf = tx.envelope_encoded();
+
+        let inner_l1_fee = l1_block_info
+            .l1_tx_data_fee(
+                &eth_api.provider().chain_spec(),
+                block_timestamp,
+                &envelope_buf,
+                tx.is_deposit(),
+            )
+            .map_err(|_| OptimismEthApiError::L1BlockFeeError)?;
+        let inner_l1_data_gas = l1_block_info
+            .l1_data_gas(&eth_api.provider().chain_spec(), block_timestamp, &envelope_buf)
+            .map_err(|_| OptimismEthApiError::L1BlockGasError)?;
+        (
+            Some(inner_l1_fee.saturating_to::<u128>()),
+            Some(inner_l1_data_gas.saturating_to::<u128>()),
+        )
+    } else {
+        (None, None)
+    };
+
+    Ok(OptimismTxMeta::new(Some(l1_block_info), l1_fee, l1_data_gas))
+}
+
+/// Applies OP specific fields to a receipts response.
+pub fn op_fields(
+    resp_builder: ReceiptResponseBuilder,
+    tx: &TransactionSigned,
+    receipt: &Receipt,
+    optimism_tx_meta: OptimismTxMeta,
+) -> ReceiptResponseBuilder {
+    let mut op_fields = OptimismTransactionReceiptFields::default();
+
+    if tx.is_deposit() {
+        op_fields.deposit_nonce = receipt.deposit_nonce.map(reth_primitives::U64::from);
+        op_fields.deposit_receipt_version =
+            receipt.deposit_receipt_version.map(reth_primitives::U64::from);
+    } else if let Some(l1_block_info) = optimism_tx_meta.l1_block_info {
+        op_fields.l1_fee = optimism_tx_meta.l1_fee;
+        op_fields.l1_gas_used = optimism_tx_meta.l1_data_gas.map(|dg| {
+            dg + l1_block_info.l1_fee_overhead.unwrap_or_default().saturating_to::<u128>()
+        });
+        op_fields.l1_fee_scalar = Some(f64::from(l1_block_info.l1_base_fee_scalar) / 1_000_000.0);
+        op_fields.l1_gas_price = Some(l1_block_info.l1_base_fee.saturating_to());
+    }
+
+    resp_builder.add_other_fields(op_fields.into())
+}
+
+/// Optimism Transaction Metadata
+///
+/// Includes the L1 fee and data gas for the tx along with the L1
+/// block info. In order to pass the [OptimismTxMeta] into the
+/// async colored [ReceiptResponseBuilder], a reference counter
+/// for the L1 block info is used so the L1 block info can be
+/// shared between receipts.
+#[derive(Debug, Default, Clone)]
+pub struct OptimismTxMeta {
+    /// The L1 block info.
+    pub l1_block_info: Option<L1BlockInfo>,
+    /// The L1 fee for the block.
+    pub l1_fee: Option<u128>,
+    /// The L1 data gas for the block.
+    pub l1_data_gas: Option<u128>,
+}
+
+impl OptimismTxMeta {
+    /// Creates a new [OptimismTxMeta].
+    pub fn new(
+        l1_block_info: Option<L1BlockInfo>,
+        l1_fee: Option<u128>,
+        l1_data_gas: Option<u128>,
+    ) -> Self {
+        Self { l1_block_info, l1_fee, l1_data_gas }
+    }
+}

crates/rpc/rpc/Cargo.toml

@@ -29,8 +29,6 @@ revm-inspectors = { workspace = true, features = ["js-tracer"] }
 reth-evm.workspace = true
 reth-network-types.workspace = true
 
-reth-evm-optimism = { workspace = true, optional = true }
-
 # eth
 alloy-rlp.workspace = true
 alloy-dyn-abi = { workspace = true, features = ["eip712"] }
@@ -91,6 +89,4 @@ optimism = [
     "reth-primitives/optimism",
     "reth-rpc-types-compat/optimism",
     "reth-provider/optimism",
-    "dep:reth-evm-optimism",
-    "reth-evm-optimism/optimism",
 ]