feat(flashblocks rpc): Full revamp of X Layer custom flashblocks RPC layer

Cargo.toml

@@ -82,54 +82,59 @@ xlayer-trace-monitor = { git = "https://github.com/okx/xlayer-toolkit", rev = "d
 # These are chain-agnostic crates from the base reth framework.
 # https://github.com/paradigmxyz/reth/tree/v1.11.3
 # ==============================================================================
-reth = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-basic-payload-builder = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-chain-state = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-chainspec = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3", default-features = false }
-reth-cli = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-cli-commands = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-cli-util = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-db = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3", default-features = false }
-reth-db-api = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3", default-features = false }
-reth-engine-primitives = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3", default-features = false }
-reth-errors = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-ethereum-forks = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3", default-features = false }
-reth-evm = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3", default-features = false }
-reth-exex = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-execution-types = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3", default-features = false }
-reth-ipc = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-metrics = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-network-peers = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3", default-features = false }
-reth-node-api = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-node-builder = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-node-core = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-node-types = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-payload-builder = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-payload-builder-primitives = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-payload-primitives = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-payload-util = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-primitives = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-primitives-traits = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3", default-features = false }
-reth-provider = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-revm = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3", default-features = false }
-reth-rpc = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-rpc-api = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-rpc-convert = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-rpc-engine-api = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-rpc-eth-api = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-rpc-eth-types = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3", default-features = false }
-reth-rpc-layer = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-rpc-server-types = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-static-file-types = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3", default-features = false }
-reth-storage-api = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3", default-features = false }
-reth-tasks = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-testing-utils = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-tokio-util = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-tracing = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3", default-features = false }
-reth-tracing-otlp = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-transaction-pool = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-trie = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3" }
-reth-trie-common = { git = "https://github.com/paradigmxyz/reth", tag = "v1.11.3", default-features = false }
+reth = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-basic-payload-builder = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-chain-state = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-chainspec = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422", default-features = false }
+reth-cli = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-cli-commands = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-cli-util = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-db = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422", default-features = false }
+reth-db-api = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422", default-features = false }
+reth-db-models = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422", default-features = false }
+reth-engine-primitives = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422", default-features = false }
+reth-engine-tree = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-errors = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-ethereum-forks = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422", default-features = false }
+reth-evm = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422", default-features = false }
+reth-exex = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-execution-types = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422", default-features = false }
+reth-ipc = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-metrics = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-network-peers = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422", default-features = false }
+reth-node-api = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-node-builder = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-node-core = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-node-types = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-payload-builder = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-payload-builder-primitives = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-payload-primitives = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-payload-util = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-primitives = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-primitives-traits = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422", default-features = false }
+reth-provider = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-revm = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422", default-features = false }
+reth-rpc = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-rpc-api = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-rpc-convert = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-rpc-engine-api = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-rpc-eth-api = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-rpc-eth-types = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422", default-features = false }
+reth-rpc-layer = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-rpc-builder = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-rpc-server-types = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-static-file-types = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422", default-features = false }
+reth-storage-api = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422", default-features = false }
+reth-tasks = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-testing-utils = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-tokio-util = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-tracing = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422", default-features = false }
+reth-tracing-otlp = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-transaction-pool = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-trie = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-trie-common = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422", default-features = false }
+reth-trie-db = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
+reth-trie-parallel = { git = "https://github.com/okx/reth", rev = "997bf9a59ee7330e434eab1706b5cb12af120422" }
 
 # ==============================================================================
 # Reth Optimism Dependencies (from local optimism/rust op-reth)
@@ -167,6 +172,7 @@ alloy-chains = { version = "0.2.30", default-features = false }
 alloy-contract = { version = "~1.6" }
 alloy-consensus = { version = "~1.6", default-features = false }
 alloy-eips = { version = "~1.6", default-features = false }
+alloy-eip7928 = { version = "0.3.0", default-features = false }
 alloy-evm = { version = "~0.27", default-features = false }
 alloy-genesis = { version = "~1.6", default-features = false }
 alloy-json-rpc = { version = "~1.6" }
@@ -223,6 +229,7 @@ jsonrpsee-core = { version = "0.26.0" }
 
 # misc
 clap = { version = "4.4.3" }
+crossbeam-channel = "0.5.13"
 derive_more = { version = "2", default-features = false, features = ["full"] }
 dashmap = "6.1"
 either = { version = "1.15.0", default-features = false }
@@ -243,7 +250,7 @@ tracing = { version = "0.1.41" }
 shellexpand = "3.1"
 url = "2.5"
 brotli = "8.0"
-ringbuffer = "0.15"
+ringbuffer = "=0.16.0"
 
 # p2p
 libp2p = { version = "0.56", features = ["identify", "ping", "noise", "tcp", "autonat", "mdns", "tokio", "cbor", "macros", "yamux", "dns"] }

bin/node/Cargo.toml

@@ -25,7 +25,10 @@ xlayer-trace-monitor.workspace = true
 
 # reth
 reth.workspace = true
+reth-chain-state.workspace = true
+reth-engine-tree.workspace = true
 reth-optimism-node.workspace = true
+reth-optimism-primitives.workspace = true
 reth-optimism-cli.workspace = true
 reth-node-api.workspace = true
 reth-node-builder.workspace = true
@@ -46,7 +49,11 @@ reth-optimism-forks.workspace = true
 reth-optimism-txpool.workspace = true
 reth-transaction-pool.workspace = true
 reth-cli-util.workspace = true
+reth-provider.workspace = true
+reth-rpc-builder.workspace = true
 reth-rpc-server-types.workspace = true
+reth-tasks = { workspace = true, features = ["rayon"] }
+reth-trie-db.workspace = true
 
 # alloy
 alloy-primitives.workspace = true
@@ -57,6 +64,9 @@ op-alloy-network.workspace = true
 # revm
 revm.workspace = true
 
+# async
+tokio.workspace = true
+
 # misc
 clap.workspace = true
 tracing.workspace = true

bin/node/src/args.rs

@@ -120,6 +120,10 @@ pub struct XLayerArgs {
     #[command(flatten)]
     pub builder: BuilderArgs,
 
+    /// Flashblocks RPC configuration
+    #[command(flatten)]
+    pub flashblocks_rpc: FlashblocksRpcArgs,
+
     /// Enable legacy rpc routing
     #[command(flatten)]
     pub legacy: LegacyRpcArgs,
@@ -132,22 +136,6 @@ pub struct XLayerArgs {
     #[command(flatten)]
     pub intercept: XLayerInterceptArgs,
 
-    /// Enable custom flashblocks subscription
-    #[arg(
-        long = "xlayer.flashblocks-subscription",
-        help = "Enable custom flashblocks subscription (disabled by default)",
-        default_value = "false"
-    )]
-    pub enable_flashblocks_subscription: bool,
-
-    /// Set the number of subscribed addresses in flashblocks subscription
-    #[arg(
-        long = "xlayer.flashblocks-subscription-max-addresses",
-        help = "Set the number of subscribed addresses in flashblocks subscription",
-        default_value = "1000"
-    )]
-    pub flashblocks_subscription_max_addresses: usize,
-
     #[arg(
         long = "xlayer.sequencer-mode",
         help = "Enable sequencer mode for the node (default: false, i.e., RPC mode). This flag can be used by various business logic components to determine node behavior.",
@@ -247,6 +235,40 @@ impl LegacyRpcArgs {
     }
 }
 
+#[derive(Debug, Clone, Args, PartialEq, Eq, Default)]
+pub struct FlashblocksRpcArgs {
+    /// Enable flashblocks RPC
+    #[arg(
+        long = "xlayer.flashblocks-url",
+        help = "URL of the flashblocks RPC endpoint (disabled by default)"
+    )]
+    pub flashblock_url: Option<Url>,
+
+    /// Enable custom flashblocks subscription
+    #[arg(
+        long = "xlayer.flashblocks-subscription",
+        help = "Enable custom flashblocks subscription (disabled by default)",
+        default_value = "false"
+    )]
+    pub enable_flashblocks_subscription: bool,
+
+    /// Set the number of subscribed addresses in flashblocks subscription
+    #[arg(
+        long = "xlayer.flashblocks-subscription-max-addresses",
+        help = "Set the number of subscribed addresses in flashblocks subscription",
+        default_value = "1000"
+    )]
+    pub flashblocks_subscription_max_addresses: usize,
+
+    /// Enable flashblocks RPC state comparison debug mode
+    #[arg(
+        long = "xlayer.flashblocks-debug-state-comparison",
+        help = "Enable flashblocks RPC state comparison debug mode",
+        default_value = "false"
+    )]
+    pub flashblocks_debug_state_comparison: bool,
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
@@ -391,13 +413,19 @@ mod tests {
             "--xlayer.flashblocks-subscription",
             "--xlayer.flashblocks-subscription-max-addresses",
             "2000",
+            "--xlayer.flashblocks-url",
+            "ws://localhost:1111",
         ])
         .args;
 
-        assert!(args.enable_flashblocks_subscription);
         assert!(args.legacy.legacy_rpc_url.is_some());
         assert_eq!(args.legacy.legacy_rpc_timeout, Duration::from_secs(45));
-        assert_eq!(args.flashblocks_subscription_max_addresses, 2000);
+        assert!(args.flashblocks_rpc.enable_flashblocks_subscription);
+        assert_eq!(args.flashblocks_rpc.flashblocks_subscription_max_addresses, 2000);
+        assert_eq!(
+            args.flashblocks_rpc.flashblock_url,
+            Some(Url::parse("ws://localhost:1111").unwrap())
+        );
         assert!(args.validate().is_ok());
     }