feat: resoure metering rpc/lookup

Author: danyalprout

Cargo.lock

@@ -213,3 +213,7 @@ time = { version = "0.3.36", features = ["macros", "formatting", "parsing"] }
 vergen = "9.0.4"
 vergen-git2 = "1.0.5"
 opentelemetry = { version = "0.31", features = ["trace"] }
+
+# Base Path
+concurrent-queue = "2.5.0"
+tips-core = { git = "https://github.com/base/tips", rev = "c08eaa4fe10c26de8911609b41ddab4918698325", default-features = false }

Cargo.toml

@@ -14,6 +14,8 @@ workspace = true
 [dependencies]
 p2p = { path = "../p2p" }
 
+tips-core.workspace = true
+
 reth.workspace = true
 reth-optimism-node.workspace = true
 reth-optimism-cli.workspace = true
@@ -112,6 +114,7 @@ url.workspace = true
 anyhow = "1"
 opentelemetry = { workspace = true, optional = true }
 dashmap.workspace = true
+concurrent-queue.workspace = true
 hex = { workspace = true }
 futures = { workspace = true }
 futures-util = { workspace = true }

crates/op-rbuilder/Cargo.toml

@@ -48,6 +48,12 @@ pub struct OpRbuilderArgs {
     /// Whether to enable revert protection by default
     #[arg(long = "builder.enable-revert-protection", default_value = "false")]
     pub enable_revert_protection: bool,
+    /// Whether to enable TIPS Resource Metering
+    #[arg(long = "builder.enable-resource-metering", default_value = "false")]
+    pub enable_resource_metering: bool,
+    /// Whether to enable TIPS Resource Metering
+    #[arg(long = "builder.resource-metering-buffer-size", default_value = "10000")]
+    pub resource_metering_buffer_size: usize,
 
     /// Path to builder playgorund to automatically start up the node connected to it
     #[arg(

crates/op-rbuilder/src/args/op.rs

@@ -47,6 +47,7 @@ use crate::{
     tx::MaybeRevertingTransaction,
     tx_signer::Signer,
 };
+use crate::resource_metering::ResourceMetering;
 
 /// Container type that holds all necessities to build a new payload.
 #[derive(Debug)]
@@ -77,6 +78,8 @@ pub struct OpPayloadBuilderCtx<ExtraCtx: Debug + Default = ()> {
     pub max_gas_per_txn: Option<u64>,
     /// Rate limiting based on gas. This is an optional feature.
     pub address_gas_limiter: AddressGasLimiter,
+    /// Per transaction resource metering information
+    pub resource_metering: ResourceMetering,
 }
 
 impl<ExtraCtx: Debug + Default> OpPayloadBuilderCtx<ExtraCtx> {
@@ -441,6 +444,8 @@ impl<ExtraCtx: Debug + Default> OpPayloadBuilderCtx<ExtraCtx> {
 
             num_txs_considered += 1;
 
+            let _resource_usage = self.resource_metering.get(&tx_hash);
+
             // TODO: ideally we should get this from the txpool stream
             if let Some(conditional) = conditional
                 && !conditional.matches_block_attributes(&block_attr)

crates/op-rbuilder/src/builders/context.rs

@@ -16,6 +16,7 @@ use reth_optimism_payload_builder::{
 use reth_optimism_primitives::OpTransactionSigned;
 use std::sync::Arc;
 use tokio_util::sync::CancellationToken;
+use crate::resource_metering::ResourceMetering;
 
 #[derive(Debug, Clone)]
 pub(super) struct OpPayloadSyncerCtx {
@@ -29,6 +30,8 @@ pub(super) struct OpPayloadSyncerCtx {
     max_gas_per_txn: Option<u64>,
     /// The metrics for the builder
     metrics: Arc<OpRBuilderMetrics>,
+    /// Resource metering tracking
+    resource_metering: ResourceMetering,
 }
 
 impl OpPayloadSyncerCtx {
@@ -48,6 +51,7 @@ impl OpPayloadSyncerCtx {
             chain_spec,
             max_gas_per_txn: builder_config.max_gas_per_txn,
             metrics,
+            resource_metering: builder_config.resource_metering,
         })
     }
 
@@ -80,6 +84,7 @@ impl OpPayloadSyncerCtx {
             extra_ctx: (),
             max_gas_per_txn: self.max_gas_per_txn,
             address_gas_limiter: AddressGasLimiter::new(GasLimiterArgs::default()),
+            resource_metering: self.resource_metering.clone(),
         }
     }
 }

crates/op-rbuilder/src/builders/flashblocks/ctx.rs

@@ -253,6 +253,7 @@ where
             extra_data,
         };
 
+
         let evm_config = self.evm_config.clone();
 
         let evm_env = evm_config
@@ -273,6 +274,7 @@ where
             extra_ctx,
             max_gas_per_txn: self.config.max_gas_per_txn,
             address_gas_limiter: self.address_gas_limiter.clone(),
+            resource_metering: self.config.resource_metering.clone(),
         })
     }
 

crates/op-rbuilder/src/builders/flashblocks/payload.rs

@@ -28,6 +28,7 @@ pub use builder_tx::{
 pub use context::OpPayloadBuilderCtx;
 pub use flashblocks::FlashblocksBuilder;
 pub use standard::StandardBuilder;
+use crate::resource_metering::ResourceMetering;
 
 /// Defines the payload building mode for the OP builder.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
@@ -126,6 +127,9 @@ pub struct BuilderConfig<Specific: Clone> {
 
     /// Address gas limiter stuff
     pub gas_limiter_config: GasLimiterArgs,
+
+    /// Resource metering context
+    pub resource_metering: ResourceMetering
 }
 
 impl<S: Debug + Clone> core::fmt::Debug for BuilderConfig<S> {
@@ -166,6 +170,7 @@ impl<S: Default + Clone> Default for BuilderConfig<S> {
             sampling_ratio: 100,
             max_gas_per_txn: None,
             gas_limiter_config: GasLimiterArgs::default(),
+            resource_metering: ResourceMetering::default(),
         }
     }
 }
@@ -188,6 +193,10 @@ where
             sampling_ratio: args.telemetry.sampling_ratio,
             max_gas_per_txn: args.max_gas_per_txn,
             gas_limiter_config: args.gas_limiter.clone(),
+            resource_metering: ResourceMetering::new(
+                args.enable_resource_metering,
+                args.resource_metering_buffer_size,
+            ),
             specific: S::try_from(args)?,
         })
     }

crates/op-rbuilder/src/builders/mod.rs

@@ -2,7 +2,6 @@ use crate::{
     builders::standard::service::StandardServiceBuilder,
     traits::{NodeBounds, PoolBounds},
 };
-
 use super::BuilderConfig;
 
 mod builder_tx;

crates/op-rbuilder/src/builders/standard/mod.rs

@@ -250,6 +250,7 @@ where
             extra_ctx: Default::default(),
             max_gas_per_txn: self.config.max_gas_per_txn,
             address_gas_limiter: self.address_gas_limiter.clone(),
+            resource_metering: self.config.resource_metering.clone(),
         };
 
         let builder = OpBuilder::new(best);