reth_cli_commands/
common.rs

1//! Contains common `reth` arguments
2
3pub use reth_primitives_traits::header::HeaderMut;
4
5use alloy_primitives::B256;
6use clap::Parser;
7use reth_chainspec::EthChainSpec;
8use reth_cli::chainspec::ChainSpecParser;
9use reth_config::{config::EtlConfig, Config};
10use reth_consensus::noop::NoopConsensus;
11use reth_db::{init_db, open_db_read_only, DatabaseEnv};
12use reth_db_common::init::init_genesis_with_settings;
13use reth_downloaders::{bodies::noop::NoopBodiesDownloader, headers::noop::NoopHeaderDownloader};
14use reth_eth_wire::NetPrimitivesFor;
15use reth_evm::{noop::NoopEvmConfig, ConfigureEvm};
16use reth_network::NetworkEventListenerProvider;
17use reth_node_api::FullNodeTypesAdapter;
18use reth_node_builder::{
19    Node, NodeComponents, NodeComponentsBuilder, NodeTypes, NodeTypesWithDBAdapter,
20};
21use reth_node_core::{
22    args::{DatabaseArgs, DatadirArgs, StaticFilesArgs},
23    dirs::{ChainPath, DataDirPath},
24};
25use reth_provider::{
26    providers::{
27        BlockchainProvider, NodeTypesForProvider, RocksDBProvider, StaticFileProvider,
28        StaticFileProviderBuilder,
29    },
30    ProviderFactory, StaticFileProviderFactory,
31};
32use reth_stages::{sets::DefaultStages, Pipeline, PipelineTarget};
33use reth_static_file::StaticFileProducer;
34use std::{path::PathBuf, sync::Arc};
35use tokio::sync::watch;
36use tracing::{debug, info, warn};
37
38/// Struct to hold config and datadir paths
39#[derive(Debug, Parser)]
40pub struct EnvironmentArgs<C: ChainSpecParser> {
41    /// Parameters for datadir configuration
42    #[command(flatten)]
43    pub datadir: DatadirArgs,
44
45    /// The path to the configuration file to use.
46    #[arg(long, value_name = "FILE")]
47    pub config: Option<PathBuf>,
48
49    /// The chain this node is running.
50    ///
51    /// Possible values are either a built-in chain or the path to a chain specification file.
52    #[arg(
53        long,
54        value_name = "CHAIN_OR_PATH",
55        long_help = C::help_message(),
56        default_value = C::default_value(),
57        value_parser = C::parser(),
58        global = true
59    )]
60    pub chain: Arc<C::ChainSpec>,
61
62    /// All database related arguments
63    #[command(flatten)]
64    pub db: DatabaseArgs,
65
66    /// All static files related arguments
67    #[command(flatten)]
68    pub static_files: StaticFilesArgs,
69}
70
71impl<C: ChainSpecParser> EnvironmentArgs<C> {
72    /// Initializes environment according to [`AccessRights`] and returns an instance of
73    /// [`Environment`].
74    pub fn init<N: CliNodeTypes>(&self, access: AccessRights) -> eyre::Result<Environment<N>>
75    where
76        C: ChainSpecParser<ChainSpec = N::ChainSpec>,
77    {
78        let data_dir = self.datadir.clone().resolve_datadir(self.chain.chain());
79        let db_path = data_dir.db();
80        let sf_path = data_dir.static_files();
81        let rocksdb_path = data_dir.rocksdb();
82
83        if access.is_read_write() {
84            reth_fs_util::create_dir_all(&db_path)?;
85            reth_fs_util::create_dir_all(&sf_path)?;
86            reth_fs_util::create_dir_all(&rocksdb_path)?;
87        }
88
89        let config_path = self.config.clone().unwrap_or_else(|| data_dir.config());
90
91        let mut config = Config::from_path(config_path)
92            .inspect_err(
93                |err| warn!(target: "reth::cli", %err, "Failed to load config file, using default"),
94            )
95            .unwrap_or_default();
96
97        // Make sure ETL doesn't default to /tmp/, but to whatever datadir is set to
98        if config.stages.etl.dir.is_none() {
99            config.stages.etl.dir = Some(EtlConfig::from_datadir(data_dir.data_dir()));
100        }
101        if config.stages.era.folder.is_none() {
102            config.stages.era = config.stages.era.with_datadir(data_dir.data_dir());
103        }
104
105        info!(target: "reth::cli", ?db_path, ?sf_path, "Opening storage");
106        let genesis_block_number = self.chain.genesis().number.unwrap_or_default();
107        let (db, sfp) = match access {
108            AccessRights::RW => (
109                Arc::new(init_db(db_path, self.db.database_args())?),
110                StaticFileProviderBuilder::read_write(sf_path)?
111                    .with_genesis_block_number(genesis_block_number)
112                    .build()?,
113            ),
114            AccessRights::RO | AccessRights::RoInconsistent => {
115                (Arc::new(open_db_read_only(&db_path, self.db.database_args())?), {
116                    let provider = StaticFileProviderBuilder::read_only(sf_path)?
117                        .with_genesis_block_number(genesis_block_number)
118                        .build()?;
119                    provider.watch_directory();
120                    provider
121                })
122            }
123        };
124        // TransactionDB only support read-write mode
125        let rocksdb_provider = RocksDBProvider::builder(data_dir.rocksdb())
126            .with_default_tables()
127            .with_database_log_level(self.db.log_level)
128            .build()?;
129
130        let provider_factory =
131            self.create_provider_factory(&config, db, sfp, rocksdb_provider, access)?;
132        if access.is_read_write() {
133            debug!(target: "reth::cli", chain=%self.chain.chain(), genesis=?self.chain.genesis_hash(), "Initializing genesis");
134            init_genesis_with_settings(&provider_factory, self.static_files.to_settings())?;
135        }
136
137        Ok(Environment { config, provider_factory, data_dir })
138    }
139
140    /// Returns a [`ProviderFactory`] after executing consistency checks.
141    ///
142    /// If it's a read-write environment and an issue is found, it will attempt to heal (including a
143    /// pipeline unwind). Otherwise, it will print out a warning, advising the user to restart the
144    /// node to heal.
145    fn create_provider_factory<N: CliNodeTypes>(
146        &self,
147        config: &Config,
148        db: Arc<DatabaseEnv>,
149        static_file_provider: StaticFileProvider<N::Primitives>,
150        rocksdb_provider: RocksDBProvider,
151        access: AccessRights,
152    ) -> eyre::Result<ProviderFactory<NodeTypesWithDBAdapter<N, Arc<DatabaseEnv>>>>
153    where
154        C: ChainSpecParser<ChainSpec = N::ChainSpec>,
155    {
156        let prune_modes = config.prune.segments.clone();
157        let factory = ProviderFactory::<NodeTypesWithDBAdapter<N, Arc<DatabaseEnv>>>::new(
158            db,
159            self.chain.clone(),
160            static_file_provider,
161            rocksdb_provider,
162        )?
163        .with_prune_modes(prune_modes.clone());
164
165        // Check for consistency between database and static files.
166        if !access.is_read_only_inconsistent() &&
167            let Some(unwind_target) =
168                factory.static_file_provider().check_consistency(&factory.provider()?)?
169        {
170            if factory.db_ref().is_read_only()? {
171                warn!(target: "reth::cli", ?unwind_target, "Inconsistent storage. Restart node to heal.");
172                return Ok(factory)
173            }
174
175            // Highly unlikely to happen, and given its destructive nature, it's better to panic
176            // instead.
177            assert_ne!(
178                unwind_target,
179                PipelineTarget::Unwind(0),
180                "A static file <> database inconsistency was found that would trigger an unwind to block 0"
181            );
182
183            info!(target: "reth::cli", unwind_target = %unwind_target, "Executing an unwind after a failed storage consistency check.");
184
185            let (_tip_tx, tip_rx) = watch::channel(B256::ZERO);
186
187            // Builds and executes an unwind-only pipeline
188            let mut pipeline = Pipeline::<NodeTypesWithDBAdapter<N, Arc<DatabaseEnv>>>::builder()
189                .add_stages(DefaultStages::new(
190                    factory.clone(),
191                    tip_rx,
192                    Arc::new(NoopConsensus::default()),
193                    NoopHeaderDownloader::default(),
194                    NoopBodiesDownloader::default(),
195                    NoopEvmConfig::<N::Evm>::default(),
196                    config.stages.clone(),
197                    prune_modes.clone(),
198                    None,
199                ))
200                .build(factory.clone(), StaticFileProducer::new(factory.clone(), prune_modes));
201
202            // Move all applicable data from database to static files.
203            pipeline.move_to_static_files()?;
204            pipeline.unwind(unwind_target.unwind_target().expect("should exist"), None)?;
205        }
206
207        Ok(factory)
208    }
209}
210
211/// Environment built from [`EnvironmentArgs`].
212#[derive(Debug)]
213pub struct Environment<N: NodeTypes> {
214    /// Configuration for reth node
215    pub config: Config,
216    /// Provider factory.
217    pub provider_factory: ProviderFactory<NodeTypesWithDBAdapter<N, Arc<DatabaseEnv>>>,
218    /// Datadir path.
219    pub data_dir: ChainPath<DataDirPath>,
220}
221
222/// Environment access rights.
223#[derive(Debug, Copy, Clone)]
224pub enum AccessRights {
225    /// Read-write access
226    RW,
227    /// Read-only access
228    RO,
229    /// Read-only access with possibly inconsistent data
230    RoInconsistent,
231}
232
233impl AccessRights {
234    /// Returns `true` if it requires read-write access to the environment.
235    pub const fn is_read_write(&self) -> bool {
236        matches!(self, Self::RW)
237    }
238
239    /// Returns `true` if it requires read-only access to the environment with possibly inconsistent
240    /// data.
241    pub const fn is_read_only_inconsistent(&self) -> bool {
242        matches!(self, Self::RoInconsistent)
243    }
244}
245
246/// Helper alias to satisfy `FullNodeTypes` bound on [`Node`] trait generic.
247type FullTypesAdapter<T> = FullNodeTypesAdapter<
248    T,
249    Arc<DatabaseEnv>,
250    BlockchainProvider<NodeTypesWithDBAdapter<T, Arc<DatabaseEnv>>>,
251>;
252
253/// Helper trait with a common set of requirements for the
254/// [`NodeTypes`] in CLI.
255pub trait CliNodeTypes: Node<FullTypesAdapter<Self>> + NodeTypesForProvider {
256    type Evm: ConfigureEvm<Primitives = Self::Primitives>;
257    type NetworkPrimitives: NetPrimitivesFor<Self::Primitives>;
258}
259
260impl<N> CliNodeTypes for N
261where
262    N: Node<FullTypesAdapter<Self>> + NodeTypesForProvider,
263{
264    type Evm = <<N::ComponentsBuilder as NodeComponentsBuilder<FullTypesAdapter<Self>>>::Components as NodeComponents<FullTypesAdapter<Self>>>::Evm;
265    type NetworkPrimitives = <<<N::ComponentsBuilder as NodeComponentsBuilder<FullTypesAdapter<Self>>>::Components as NodeComponents<FullTypesAdapter<Self>>>::Network as NetworkEventListenerProvider>::Primitives;
266}
267
268type EvmFor<N> = <<<N as Node<FullTypesAdapter<N>>>::ComponentsBuilder as NodeComponentsBuilder<
269    FullTypesAdapter<N>,
270>>::Components as NodeComponents<FullTypesAdapter<N>>>::Evm;
271
272type ConsensusFor<N> =
273    <<<N as Node<FullTypesAdapter<N>>>::ComponentsBuilder as NodeComponentsBuilder<
274        FullTypesAdapter<N>,
275    >>::Components as NodeComponents<FullTypesAdapter<N>>>::Consensus;
276
277/// Helper trait aggregating components required for the CLI.
278pub trait CliNodeComponents<N: CliNodeTypes>: Send + Sync + 'static {
279    /// Returns the configured EVM.
280    fn evm_config(&self) -> &EvmFor<N>;
281    /// Returns the consensus implementation.
282    fn consensus(&self) -> &ConsensusFor<N>;
283}
284
285impl<N: CliNodeTypes> CliNodeComponents<N> for (EvmFor<N>, ConsensusFor<N>) {
286    fn evm_config(&self) -> &EvmFor<N> {
287        &self.0
288    }
289
290    fn consensus(&self) -> &ConsensusFor<N> {
291        &self.1
292    }
293}
294
295/// Helper trait alias for an [`FnOnce`] producing [`CliNodeComponents`].
296pub trait CliComponentsBuilder<N: CliNodeTypes>:
297    FnOnce(Arc<N::ChainSpec>) -> Self::Components + Send + Sync + 'static
298{
299    type Components: CliNodeComponents<N>;
300}
301
302impl<N: CliNodeTypes, F, Comp> CliComponentsBuilder<N> for F
303where
304    F: FnOnce(Arc<N::ChainSpec>) -> Comp + Send + Sync + 'static,
305    Comp: CliNodeComponents<N>,
306{
307    type Components = Comp;
308}
reth_cli_commands/common.rs

reth_cli_commands/
common.rs
