reth_rpc_eth_types/builder/
config.rs

1//! Configuration for `eth` namespace APIs.
2
3use std::time::Duration;
4
5use crate::{
6    EthStateCacheConfig, FeeHistoryCacheConfig, ForwardConfig, GasPriceOracleConfig,
7    RPC_DEFAULT_GAS_CAP,
8};
9use reqwest::Url;
10use reth_rpc_server_types::constants::{
11    default_max_tracing_requests, DEFAULT_ETH_PROOF_WINDOW, DEFAULT_MAX_BLOCKS_PER_FILTER,
12    DEFAULT_MAX_LOGS_PER_RESPONSE, DEFAULT_MAX_SIMULATE_BLOCKS, DEFAULT_MAX_TRACE_FILTER_BLOCKS,
13    DEFAULT_PROOF_PERMITS, RPC_DEFAULT_SEND_RAW_TX_SYNC_TIMEOUT_SECS,
14};
15use serde::{Deserialize, Serialize};
16
17/// Default value for stale filter ttl
18pub const DEFAULT_STALE_FILTER_TTL: Duration = Duration::from_secs(5 * 60);
19
20/// Config for the locally built pending block
21#[derive(Debug, Clone, Copy, Eq, PartialEq, Serialize, Deserialize, Default)]
22#[serde(rename_all = "lowercase")]
23pub enum PendingBlockKind {
24    /// Return a pending block with header only, no transactions included
25    Empty,
26    /// Return null/no pending block
27    None,
28    /// Return a pending block with all transactions from the mempool (default behavior)
29    #[default]
30    Full,
31}
32
33impl std::str::FromStr for PendingBlockKind {
34    type Err = String;
35
36    fn from_str(s: &str) -> Result<Self, Self::Err> {
37        match s.to_lowercase().as_str() {
38            "empty" => Ok(Self::Empty),
39            "none" => Ok(Self::None),
40            "full" => Ok(Self::Full),
41            _ => Err(format!(
42                "Invalid pending block kind: {s}. Valid options are: empty, none, full"
43            )),
44        }
45    }
46}
47
48impl PendingBlockKind {
49    /// Returns true if the pending block kind is `None`
50    pub const fn is_none(&self) -> bool {
51        matches!(self, Self::None)
52    }
53
54    /// Returns true if the pending block kind is `Empty`
55    pub const fn is_empty(&self) -> bool {
56        matches!(self, Self::Empty)
57    }
58}
59
60/// Additional config values for the eth namespace.
61#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
62pub struct EthConfig {
63    /// Settings for the caching layer
64    pub cache: EthStateCacheConfig,
65    /// Settings for the gas price oracle
66    pub gas_oracle: GasPriceOracleConfig,
67    /// The maximum number of blocks into the past for generating state proofs.
68    pub eth_proof_window: u64,
69    /// The maximum number of tracing calls that can be executed in concurrently.
70    pub max_tracing_requests: usize,
71    /// Maximum number of blocks for `trace_filter` requests.
72    pub max_trace_filter_blocks: u64,
73    /// Maximum number of blocks that could be scanned per filter request in `eth_getLogs` calls.
74    pub max_blocks_per_filter: u64,
75    /// Maximum number of logs that can be returned in a single response in `eth_getLogs` calls.
76    pub max_logs_per_response: usize,
77    /// Gas limit for `eth_call` and call tracing RPC methods.
78    ///
79    /// Defaults to [`RPC_DEFAULT_GAS_CAP`]
80    pub rpc_gas_cap: u64,
81    /// Max number of blocks for `eth_simulateV1`.
82    pub rpc_max_simulate_blocks: u64,
83    ///
84    /// Sets TTL for stale filters
85    pub stale_filter_ttl: Duration,
86    /// Settings for the fee history cache
87    pub fee_history_cache: FeeHistoryCacheConfig,
88    /// The maximum number of getproof calls that can be executed concurrently.
89    pub proof_permits: usize,
90    /// Maximum batch size for transaction pool insertions.
91    pub max_batch_size: usize,
92    /// Controls how pending blocks are built when requested via RPC methods
93    pub pending_block_kind: PendingBlockKind,
94    /// The raw transaction forwarder.
95    pub raw_tx_forwarder: ForwardConfig,
96    /// Timeout duration for `send_raw_transaction_sync` RPC method.
97    pub send_raw_transaction_sync_timeout: Duration,
98}
99
100impl EthConfig {
101    /// Returns the filter config for the `eth_filter` handler.
102    pub fn filter_config(&self) -> EthFilterConfig {
103        EthFilterConfig::default()
104            .max_blocks_per_filter(self.max_blocks_per_filter)
105            .max_logs_per_response(self.max_logs_per_response)
106            .stale_filter_ttl(self.stale_filter_ttl)
107    }
108}
109
110impl Default for EthConfig {
111    fn default() -> Self {
112        Self {
113            cache: EthStateCacheConfig::default(),
114            gas_oracle: GasPriceOracleConfig::default(),
115            eth_proof_window: DEFAULT_ETH_PROOF_WINDOW,
116            max_tracing_requests: default_max_tracing_requests(),
117            max_trace_filter_blocks: DEFAULT_MAX_TRACE_FILTER_BLOCKS,
118            max_blocks_per_filter: DEFAULT_MAX_BLOCKS_PER_FILTER,
119            max_logs_per_response: DEFAULT_MAX_LOGS_PER_RESPONSE,
120            rpc_gas_cap: RPC_DEFAULT_GAS_CAP.into(),
121            rpc_max_simulate_blocks: DEFAULT_MAX_SIMULATE_BLOCKS,
122            stale_filter_ttl: DEFAULT_STALE_FILTER_TTL,
123            fee_history_cache: FeeHistoryCacheConfig::default(),
124            proof_permits: DEFAULT_PROOF_PERMITS,
125            max_batch_size: 1,
126            pending_block_kind: PendingBlockKind::Full,
127            raw_tx_forwarder: ForwardConfig::default(),
128            send_raw_transaction_sync_timeout: RPC_DEFAULT_SEND_RAW_TX_SYNC_TIMEOUT_SECS,
129        }
130    }
131}
132
133impl EthConfig {
134    /// Configures the caching layer settings
135    pub const fn state_cache(mut self, cache: EthStateCacheConfig) -> Self {
136        self.cache = cache;
137        self
138    }
139
140    /// Configures the gas price oracle settings
141    pub const fn gpo_config(mut self, gas_oracle_config: GasPriceOracleConfig) -> Self {
142        self.gas_oracle = gas_oracle_config;
143        self
144    }
145
146    /// Configures the maximum number of tracing requests
147    pub const fn max_tracing_requests(mut self, max_requests: usize) -> Self {
148        self.max_tracing_requests = max_requests;
149        self
150    }
151
152    /// Configures the maximum block length to scan per `eth_getLogs` request
153    pub const fn max_blocks_per_filter(mut self, max_blocks: u64) -> Self {
154        self.max_blocks_per_filter = max_blocks;
155        self
156    }
157
158    /// Configures the maximum number of blocks for `trace_filter` requests
159    pub const fn max_trace_filter_blocks(mut self, max_blocks: u64) -> Self {
160        self.max_trace_filter_blocks = max_blocks;
161        self
162    }
163
164    /// Configures the maximum number of logs per response
165    pub const fn max_logs_per_response(mut self, max_logs: usize) -> Self {
166        self.max_logs_per_response = max_logs;
167        self
168    }
169
170    /// Configures the maximum gas limit for `eth_call` and call tracing RPC methods
171    pub const fn rpc_gas_cap(mut self, rpc_gas_cap: u64) -> Self {
172        self.rpc_gas_cap = rpc_gas_cap;
173        self
174    }
175
176    /// Configures the maximum gas limit for `eth_call` and call tracing RPC methods
177    pub const fn rpc_max_simulate_blocks(mut self, max_blocks: u64) -> Self {
178        self.rpc_max_simulate_blocks = max_blocks;
179        self
180    }
181
182    /// Configures the maximum proof window for historical proof generation.
183    pub const fn eth_proof_window(mut self, window: u64) -> Self {
184        self.eth_proof_window = window;
185        self
186    }
187
188    /// Configures the number of getproof requests
189    pub const fn proof_permits(mut self, permits: usize) -> Self {
190        self.proof_permits = permits;
191        self
192    }
193
194    /// Configures the maximum batch size for transaction pool insertions
195    pub const fn max_batch_size(mut self, max_batch_size: usize) -> Self {
196        self.max_batch_size = max_batch_size;
197        self
198    }
199
200    /// Configures the pending block config
201    pub const fn pending_block_kind(mut self, pending_block_kind: PendingBlockKind) -> Self {
202        self.pending_block_kind = pending_block_kind;
203        self
204    }
205
206    /// Configures the raw transaction forwarder.
207    pub fn raw_tx_forwarder(mut self, tx_forwarder: Option<Url>) -> Self {
208        if let Some(tx_forwarder) = tx_forwarder {
209            self.raw_tx_forwarder.tx_forwarder = Some(tx_forwarder);
210        }
211        self
212    }
213
214    /// Configures the timeout duration for `send_raw_transaction_sync` RPC method.
215    pub const fn send_raw_transaction_sync_timeout(mut self, timeout: Duration) -> Self {
216        self.send_raw_transaction_sync_timeout = timeout;
217        self
218    }
219}
220
221/// Config for the filter
222#[derive(Debug, Clone, PartialEq, Eq)]
223pub struct EthFilterConfig {
224    /// Maximum number of blocks that a filter can scan for logs.
225    ///
226    /// If `None` then no limit is enforced.
227    pub max_blocks_per_filter: Option<u64>,
228    /// Maximum number of logs that can be returned in a single response in `eth_getLogs` calls.
229    ///
230    /// If `None` then no limit is enforced.
231    pub max_logs_per_response: Option<usize>,
232    /// How long a filter remains valid after the last poll.
233    ///
234    /// A filter is considered stale if it has not been polled for longer than this duration and
235    /// will be removed.
236    pub stale_filter_ttl: Duration,
237}
238
239impl EthFilterConfig {
240    /// Sets the maximum number of blocks that a filter can scan for logs.
241    pub const fn max_blocks_per_filter(mut self, num: u64) -> Self {
242        self.max_blocks_per_filter = Some(num);
243        self
244    }
245
246    /// Sets the maximum number of logs that can be returned in a single response in `eth_getLogs`
247    /// calls.
248    pub const fn max_logs_per_response(mut self, num: usize) -> Self {
249        self.max_logs_per_response = Some(num);
250        self
251    }
252
253    /// Sets how long a filter remains valid after the last poll before it will be removed.
254    pub const fn stale_filter_ttl(mut self, duration: Duration) -> Self {
255        self.stale_filter_ttl = duration;
256        self
257    }
258}
259
260impl Default for EthFilterConfig {
261    fn default() -> Self {
262        Self {
263            max_blocks_per_filter: None,
264            max_logs_per_response: None,
265            // 5min
266            stale_filter_ttl: Duration::from_secs(5 * 60),
267        }
268    }
269}
reth_rpc_eth_types/builder/config.rs

reth_rpc_eth_types/builder/
config.rs
