feat: use engine launcher as default (#13709)

This commit is contained in:
Matthias Seitz
2025-01-07 18:16:21 +01:00
committed by GitHub
parent f7f2012156
commit 2b301aa102
10 changed files with 55 additions and 389 deletions

3
Cargo.lock generated
View File

@ -2933,6 +2933,7 @@ dependencies = [
"reth", "reth",
"reth-basic-payload-builder", "reth-basic-payload-builder",
"reth-chainspec", "reth-chainspec",
"reth-engine-local",
"reth-ethereum-payload-builder", "reth-ethereum-payload-builder",
"reth-node-api", "reth-node-api",
"reth-node-core", "reth-node-core",
@ -8045,7 +8046,6 @@ dependencies = [
"jsonrpsee", "jsonrpsee",
"rayon", "rayon",
"reth-beacon-consensus", "reth-beacon-consensus",
"reth-blockchain-tree",
"reth-chain-state", "reth-chain-state",
"reth-chainspec", "reth-chainspec",
"reth-cli-util", "reth-cli-util",
@ -8072,7 +8072,6 @@ dependencies = [
"reth-node-events", "reth-node-events",
"reth-node-metrics", "reth-node-metrics",
"reth-payload-builder", "reth-payload-builder",
"reth-payload-validator",
"reth-primitives", "reth-primitives",
"reth-provider", "reth-provider",
"reth-prune", "reth-prune",

View File

@ -13,9 +13,7 @@ use reth_node_builder::{
PayloadTypes, PayloadTypes,
}; };
use reth_node_core::args::{DiscoveryArgs, NetworkArgs, RpcServerArgs}; use reth_node_core::args::{DiscoveryArgs, NetworkArgs, RpcServerArgs};
use reth_provider::providers::{ use reth_provider::providers::{BlockchainProvider2, NodeTypesForProvider, NodeTypesForTree};
BlockchainProvider, BlockchainProvider2, NodeTypesForProvider, NodeTypesForTree,
};
use reth_rpc_server_types::RpcModuleSelection; use reth_rpc_server_types::RpcModuleSelection;
use reth_tasks::TaskManager; use reth_tasks::TaskManager;
use std::sync::Arc; use std::sync::Arc;
@ -58,7 +56,10 @@ where
TmpNodeAdapter<N>, TmpNodeAdapter<N>,
Components: NodeComponents<TmpNodeAdapter<N>, Network: PeersHandleProvider>, Components: NodeComponents<TmpNodeAdapter<N>, Network: PeersHandleProvider>,
>, >,
N::AddOns: RethRpcAddOns<Adapter<N>>, N::AddOns: RethRpcAddOns<Adapter<N>> + EngineValidatorAddOn<Adapter<N>>,
LocalPayloadAttributesBuilder<N::ChainSpec>: PayloadAttributesBuilder<
<<N as NodeTypesWithEngine>::Engine as PayloadTypes>::PayloadAttributes,
>,
{ {
let tasks = TaskManager::current(); let tasks = TaskManager::current();
let exec = tasks.executor(); let exec = tasks.executor();
@ -203,11 +204,11 @@ where
/// Testing database /// Testing database
pub type TmpDB = Arc<TempDatabase<DatabaseEnv>>; pub type TmpDB = Arc<TempDatabase<DatabaseEnv>>;
type TmpNodeAdapter<N, Provider = BlockchainProvider<NodeTypesWithDBAdapter<N, TmpDB>>> = type TmpNodeAdapter<N, Provider = BlockchainProvider2<NodeTypesWithDBAdapter<N, TmpDB>>> =
FullNodeTypesAdapter<N, TmpDB, Provider>; FullNodeTypesAdapter<N, TmpDB, Provider>;
/// Type alias for a `NodeAdapter` /// Type alias for a `NodeAdapter`
pub type Adapter<N, Provider = BlockchainProvider<NodeTypesWithDBAdapter<N, TmpDB>>> = NodeAdapter< pub type Adapter<N, Provider = BlockchainProvider2<NodeTypesWithDBAdapter<N, TmpDB>>> = NodeAdapter<
TmpNodeAdapter<N, Provider>, TmpNodeAdapter<N, Provider>,
<<N as Node<TmpNodeAdapter<N, Provider>>>::ComponentsBuilder as NodeComponentsBuilder< <<N as Node<TmpNodeAdapter<N, Provider>>>::ComponentsBuilder as NodeComponentsBuilder<
TmpNodeAdapter<N, Provider>, TmpNodeAdapter<N, Provider>,
@ -215,5 +216,5 @@ pub type Adapter<N, Provider = BlockchainProvider<NodeTypesWithDBAdapter<N, TmpD
>; >;
/// Type alias for a type of `NodeHelper` /// Type alias for a type of `NodeHelper`
pub type NodeHelperType<N, Provider = BlockchainProvider<NodeTypesWithDBAdapter<N, TmpDB>>> = pub type NodeHelperType<N, Provider = BlockchainProvider2<NodeTypesWithDBAdapter<N, TmpDB>>> =
NodeTestContext<Adapter<N, Provider>, <N as Node<TmpNodeAdapter<N, Provider>>>::AddOns>; NodeTestContext<Adapter<N, Provider>, <N as Node<TmpNodeAdapter<N, Provider>>>::AddOns>;

View File

@ -59,3 +59,19 @@ where
} }
} }
} }
/// A temporary workaround to support local payload engine launcher for arbitrary payload
/// attributes.
// TODO(mattsse): This should be reworked so that LocalPayloadAttributesBuilder can be implemented
// for any
pub trait UnsupportedLocalAttributes: Send + Sync + 'static {}
impl<T, ChainSpec> PayloadAttributesBuilder<T> for LocalPayloadAttributesBuilder<ChainSpec>
where
ChainSpec: Send + Sync + 'static,
T: UnsupportedLocalAttributes,
{
fn build(&self, _: u64) -> T {
panic!("Unsupported payload attributes")
}
}

View File

@ -37,7 +37,7 @@ use reth_node_builder::{
Components, ComponentsBuilder, ConsensusBuilder, ExecutorBuilder, NodeComponentsBuilder, Components, ComponentsBuilder, ConsensusBuilder, ExecutorBuilder, NodeComponentsBuilder,
PoolBuilder, PoolBuilder,
}, },
BuilderContext, Node, NodeAdapter, RethFullAdapter2, BuilderContext, Node, NodeAdapter, RethFullAdapter,
}; };
use reth_node_core::node_config::NodeConfig; use reth_node_core::node_config::NodeConfig;
use reth_node_ethereum::{ use reth_node_ethereum::{
@ -169,14 +169,14 @@ pub type TmpDB = Arc<TempDatabase<DatabaseEnv>>;
/// The [`NodeAdapter`] for the [`TestExExContext`]. Contains type necessary to /// The [`NodeAdapter`] for the [`TestExExContext`]. Contains type necessary to
/// boot the testing environment /// boot the testing environment
pub type Adapter = NodeAdapter< pub type Adapter = NodeAdapter<
RethFullAdapter2<TmpDB, TestNode>, RethFullAdapter<TmpDB, TestNode>,
<<TestNode as Node< <<TestNode as Node<
FullNodeTypesAdapter< FullNodeTypesAdapter<
TestNode, TestNode,
TmpDB, TmpDB,
BlockchainProvider2<NodeTypesWithDBAdapter<TestNode, TmpDB>>, BlockchainProvider2<NodeTypesWithDBAdapter<TestNode, TmpDB>>,
>, >,
>>::ComponentsBuilder as NodeComponentsBuilder<RethFullAdapter2<TmpDB, TestNode>>>::Components, >>::ComponentsBuilder as NodeComponentsBuilder<RethFullAdapter<TmpDB, TestNode>>>::Components,
>; >;
/// An [`ExExContext`] using the [`Adapter`] type. /// An [`ExExContext`] using the [`Adapter`] type.
pub type TestExExContext = ExExContext<Adapter>; pub type TestExExContext = ExExContext<Adapter>;

View File

@ -14,7 +14,6 @@ workspace = true
[dependencies] [dependencies]
## reth ## reth
reth-beacon-consensus.workspace = true reth-beacon-consensus.workspace = true
reth-blockchain-tree.workspace = true
reth-chain-state.workspace = true reth-chain-state.workspace = true
reth-chainspec.workspace = true reth-chainspec.workspace = true
reth-cli-util.workspace = true reth-cli-util.workspace = true
@ -41,7 +40,6 @@ reth-node-core.workspace = true
reth-node-events.workspace = true reth-node-events.workspace = true
reth-node-metrics.workspace = true reth-node-metrics.workspace = true
reth-payload-builder.workspace = true reth-payload-builder.workspace = true
reth-payload-validator.workspace = true
reth-primitives.workspace = true reth-primitives.workspace = true
reth-provider.workspace = true reth-provider.workspace = true
reth-prune.workspace = true reth-prune.workspace = true
@ -99,7 +97,6 @@ default = []
js-tracer = ["reth-rpc/js-tracer"] js-tracer = ["reth-rpc/js-tracer"]
test-utils = [ test-utils = [
"reth-db/test-utils", "reth-db/test-utils",
"reth-blockchain-tree/test-utils",
"reth-chain-state/test-utils", "reth-chain-state/test-utils",
"reth-chainspec/test-utils", "reth-chainspec/test-utils",
"reth-consensus/test-utils", "reth-consensus/test-utils",

View File

@ -9,7 +9,7 @@ graph TD;
end end
NodeBuilderC--"launch"-->launch NodeBuilderC--"launch"-->launch
subgraph launch subgraph launch
database("database init")-->tree("blockchain tree init") database("database init")-->tree("blockchain provider init")
tree--BuilderContext-->components{"build_components"} tree--BuilderContext-->components{"build_components"}
subgraph components subgraph components
ComponentsBuilder--"first creates"-->Pool ComponentsBuilder--"first creates"-->Pool

View File

@ -7,11 +7,10 @@ use crate::{
components::NodeComponentsBuilder, components::NodeComponentsBuilder,
node::FullNode, node::FullNode,
rpc::{RethRpcAddOns, RethRpcServerHandles, RpcContext}, rpc::{RethRpcAddOns, RethRpcServerHandles, RpcContext},
BlockReaderFor, DefaultNodeLauncher, LaunchNode, Node, NodeHandle, BlockReaderFor, EngineNodeLauncher, LaunchNode, Node,
}; };
use alloy_eips::eip4844::env_settings::EnvKzgSettings; use alloy_eips::eip4844::env_settings::EnvKzgSettings;
use futures::Future; use futures::Future;
use reth_blockchain_tree::externals::NodeTypesForTree;
use reth_chainspec::{EthChainSpec, EthereumHardforks, Hardforks}; use reth_chainspec::{EthChainSpec, EthereumHardforks, Hardforks};
use reth_cli_util::get_secret_key; use reth_cli_util::get_secret_key;
use reth_db_api::{ use reth_db_api::{
@ -34,7 +33,7 @@ use reth_node_core::{
primitives::Head, primitives::Head,
}; };
use reth_provider::{ use reth_provider::{
providers::{BlockchainProvider, BlockchainProvider2, NodeTypesForProvider}, providers::{BlockchainProvider2, NodeTypesForProvider, NodeTypesForTree},
ChainSpecProvider, FullProvider, ChainSpecProvider, FullProvider,
}; };
use reth_tasks::TaskExecutor; use reth_tasks::TaskExecutor;
@ -51,11 +50,6 @@ pub use states::*;
/// The adapter type for a reth node with the builtin provider type /// The adapter type for a reth node with the builtin provider type
// Note: we need to hardcode this because custom components might depend on it in associated types. // Note: we need to hardcode this because custom components might depend on it in associated types.
pub type RethFullAdapter<DB, Types> = pub type RethFullAdapter<DB, Types> =
FullNodeTypesAdapter<Types, DB, BlockchainProvider<NodeTypesWithDBAdapter<Types, DB>>>;
/// The adapter type for a reth node with the builtin provider type
// Note: we need to hardcode this because custom components might depend on it in associated types.
pub type RethFullAdapter2<DB, Types> =
FullNodeTypesAdapter<Types, DB, BlockchainProvider2<NodeTypesWithDBAdapter<Types, DB>>>; FullNodeTypesAdapter<Types, DB, BlockchainProvider2<NodeTypesWithDBAdapter<Types, DB>>>;
#[allow(clippy::doc_markdown)] #[allow(clippy::doc_markdown)]
@ -346,18 +340,14 @@ where
/// ///
/// This bootstraps the node internals, creates all the components with the given [Node] /// This bootstraps the node internals, creates all the components with the given [Node]
/// ///
/// Returns a [`NodeHandle`] that can be used to interact with the node. /// Returns a [`NodeHandle`](crate::NodeHandle) that can be used to interact with the node.
pub async fn launch_node<N>( pub async fn launch_node<N>(
self, self,
node: N, node: N,
) -> eyre::Result< ) -> eyre::Result<
NodeHandle< <EngineNodeLauncher as LaunchNode<
NodeAdapter< NodeBuilderWithComponents<RethFullAdapter<DB, N>, N::ComponentsBuilder, N::AddOns>,
RethFullAdapter<DB, N>, >>::Node,
<N::ComponentsBuilder as NodeComponentsBuilder<RethFullAdapter<DB, N>>>::Components,
>,
N::AddOns,
>,
> >
where where
N: Node<RethFullAdapter<DB, N>, ChainSpec = ChainSpec> + NodeTypesForTree, N: Node<RethFullAdapter<DB, N>, ChainSpec = ChainSpec> + NodeTypesForTree,
@ -368,6 +358,9 @@ where
>, >,
>, >,
N::Primitives: FullNodePrimitives<BlockBody = reth_primitives::BlockBody>, N::Primitives: FullNodePrimitives<BlockBody = reth_primitives::BlockBody>,
EngineNodeLauncher: LaunchNode<
NodeBuilderWithComponents<RethFullAdapter<DB, N>, N::ComponentsBuilder, N::AddOns>,
>,
{ {
self.node(node).launch().await self.node(node).launch().await
} }
@ -558,14 +551,20 @@ where
T: NodeTypesWithEngine + NodeTypesForTree, T: NodeTypesWithEngine + NodeTypesForTree,
CB: NodeComponentsBuilder<RethFullAdapter<DB, T>>, CB: NodeComponentsBuilder<RethFullAdapter<DB, T>>,
AO: RethRpcAddOns<NodeAdapter<RethFullAdapter<DB, T>, CB::Components>>, AO: RethRpcAddOns<NodeAdapter<RethFullAdapter<DB, T>, CB::Components>>,
EngineNodeLauncher: LaunchNode<NodeBuilderWithComponents<RethFullAdapter<DB, T>, CB, AO>>,
{ {
/// Launches the node with the [`DefaultNodeLauncher`] that sets up engine API consensus and rpc /// Launches the node with the [`EngineNodeLauncher`] that sets up engine API consensus and rpc
pub async fn launch( pub async fn launch(
self, self,
) -> eyre::Result<NodeHandle<NodeAdapter<RethFullAdapter<DB, T>, CB::Components>, AO>> { ) -> eyre::Result<
<EngineNodeLauncher as LaunchNode<
NodeBuilderWithComponents<RethFullAdapter<DB, T>, CB, AO>,
>>::Node,
> {
let Self { builder, task_executor } = self; let Self { builder, task_executor } = self;
let launcher = DefaultNodeLauncher::new(task_executor, builder.config.datadir()); let launcher =
EngineNodeLauncher::new(task_executor, builder.config.datadir(), Default::default());
builder.launch_with(launcher).await builder.launch_with(launcher).await
} }
} }

View File

@ -6,50 +6,12 @@ mod exex;
pub(crate) mod engine; pub(crate) mod engine;
pub use common::LaunchContext; pub use common::LaunchContext;
use common::{Attached, LaunchContextWith, WithConfigs};
pub use exex::ExExLauncher; pub use exex::ExExLauncher;
use reth_db_api::{
database_metrics::{DatabaseMetadata, DatabaseMetrics},
Database,
};
use std::{future::Future, sync::Arc}; use std::future::Future;
use futures::{future::Either, stream, stream_select, StreamExt};
use reth_beacon_consensus::{
hooks::{EngineHooks, PruneHook, StaticFileHook},
BeaconConsensusEngine,
};
use reth_blockchain_tree::{
noop::NoopBlockchainTree, BlockchainTree, BlockchainTreeConfig, ShareableBlockchainTree,
TreeExternals,
};
use reth_chainspec::EthChainSpec;
use reth_consensus_debug_client::{DebugConsensusClient, EtherscanBlockProvider, RpcBlockProvider};
use reth_engine_util::EngineMessageStreamExt;
use reth_exex::ExExManagerHandle;
use reth_network::BlockDownloaderProvider;
use reth_node_api::{AddOnsContext, FullNodeTypes, NodeTypesWithDBAdapter, NodeTypesWithEngine};
use reth_node_core::{
dirs::{ChainPath, DataDirPath},
exit::NodeExitFuture,
};
use reth_node_events::{cl::ConsensusLayerHealthEvents, node, node::NodeEvent};
use reth_provider::providers::{BlockchainProvider, NodeTypesForTree};
use reth_rpc::eth::RpcNodeCore; use reth_rpc::eth::RpcNodeCore;
use reth_tasks::TaskExecutor; use reth_tasks::TaskExecutor;
use reth_tracing::tracing::{debug, info};
use tokio::sync::{mpsc::unbounded_channel, oneshot};
use tokio_stream::wrappers::UnboundedReceiverStream;
use crate::{
builder::{NodeAdapter, NodeTypesAdapter},
components::{NodeComponents, NodeComponentsBuilder},
hooks::NodeHooks,
node::FullNode,
rpc::{RethRpcAddOns, RpcHandle},
AddOns, NodeBuilderWithComponents, NodeHandle,
};
/// Alias for [`reth_rpc_eth_types::EthApiBuilderCtx`], adapter for [`RpcNodeCore`]. /// Alias for [`reth_rpc_eth_types::EthApiBuilderCtx`], adapter for [`RpcNodeCore`].
pub type EthApiBuilderCtx<N> = reth_rpc_eth_types::EthApiBuilderCtx< pub type EthApiBuilderCtx<N> = reth_rpc_eth_types::EthApiBuilderCtx<
@ -68,7 +30,8 @@ pub type EthApiBuilderCtx<N> = reth_rpc_eth_types::EthApiBuilderCtx<
/// ///
/// This is essentially the launch logic for a node. /// This is essentially the launch logic for a node.
/// ///
/// See also [`DefaultNodeLauncher`] and [`NodeBuilderWithComponents::launch_with`] /// See also [`EngineNodeLauncher`](crate::EngineNodeLauncher) and
/// [`NodeBuilderWithComponents::launch_with`](crate::NodeBuilderWithComponents)
pub trait LaunchNode<Target> { pub trait LaunchNode<Target> {
/// The node type that is created. /// The node type that is created.
type Node; type Node;
@ -88,317 +51,3 @@ where
self(target) self(target)
} }
} }
/// The default launcher for a node.
#[derive(Debug)]
pub struct DefaultNodeLauncher {
/// The task executor for the node.
pub ctx: LaunchContext,
}
impl DefaultNodeLauncher {
/// Create a new instance of the default node launcher.
pub const fn new(task_executor: TaskExecutor, data_dir: ChainPath<DataDirPath>) -> Self {
Self { ctx: LaunchContext::new(task_executor, data_dir) }
}
}
impl<Types, DB, T, CB, AO> LaunchNode<NodeBuilderWithComponents<T, CB, AO>> for DefaultNodeLauncher
where
Types: NodeTypesWithEngine + NodeTypesForTree,
DB: Database + DatabaseMetrics + DatabaseMetadata + Clone + Unpin + 'static,
T: FullNodeTypes<
Provider = BlockchainProvider<NodeTypesWithDBAdapter<Types, DB>>,
Types = Types,
DB = DB,
>,
CB: NodeComponentsBuilder<T>,
AO: RethRpcAddOns<NodeAdapter<T, CB::Components>>,
{
type Node = NodeHandle<NodeAdapter<T, CB::Components>, AO>;
async fn launch_node(
self,
target: NodeBuilderWithComponents<T, CB, AO>,
) -> eyre::Result<Self::Node> {
let Self { ctx } = self;
let NodeBuilderWithComponents {
adapter: NodeTypesAdapter { database },
components_builder,
add_ons: AddOns { hooks, exexs: installed_exex, add_ons },
config,
} = target;
let NodeHooks { on_component_initialized, on_node_started, .. } = hooks;
// TODO: remove tree and move tree_config and canon_state_notification_sender
// initialization to with_blockchain_db once the engine revamp is done
// https://github.com/paradigmxyz/reth/issues/8742
let tree_config = BlockchainTreeConfig::default();
// NOTE: This is a temporary workaround to provide the canon state notification sender to the components builder because there's a cyclic dependency between the blockchain provider and the tree component. This will be removed once the Blockchain provider no longer depends on an instance of the tree: <https://github.com/paradigmxyz/reth/issues/7154>
let (canon_state_notification_sender, _receiver) =
tokio::sync::broadcast::channel(tree_config.max_reorg_depth() as usize * 2);
let tree = Arc::new(NoopBlockchainTree::with_canon_state_notifications(
canon_state_notification_sender.clone(),
));
// setup the launch context
let mut ctx = ctx
.with_configured_globals()
// load the toml config
.with_loaded_toml_config(config)?
// add resolved peers
.with_resolved_peers().await?
// attach the database
.attach(database.clone())
// ensure certain settings take effect
.with_adjusted_configs()
// Create the provider factory
.with_provider_factory().await?
.inspect(|_| {
info!(target: "reth::cli", "Database opened");
})
.with_prometheus_server().await?
.inspect(|this| {
debug!(target: "reth::cli", chain=%this.chain_id(), genesis=?this.genesis_hash(), "Initializing genesis");
})
.with_genesis()?
.inspect(|this: &LaunchContextWith<Attached<WithConfigs<Types::ChainSpec>, _>>| {
info!(target: "reth::cli", "\n{}", this.chain_spec().display_hardforks());
})
.with_metrics_task()
// passing FullNodeTypes as type parameter here so that we can build
// later the components.
.with_blockchain_db::<T, _>(move |provider_factory| {
Ok(BlockchainProvider::new(provider_factory, tree)?)
})?
.with_components(components_builder, on_component_initialized).await?;
let consensus = Arc::new(ctx.components().consensus().clone());
let tree_externals = TreeExternals::new(
ctx.provider_factory().clone(),
consensus.clone(),
ctx.components().block_executor().clone(),
);
let tree = BlockchainTree::new(tree_externals, tree_config)?
.with_sync_metrics_tx(ctx.sync_metrics_tx())
// Note: This is required because we need to ensure that both the components and the
// tree are using the same channel for canon state notifications. This will be removed
// once the Blockchain provider no longer depends on an instance of the tree
.with_canon_state_notification_sender(canon_state_notification_sender);
let blockchain_tree = Arc::new(ShareableBlockchainTree::new(tree));
ctx.node_adapter_mut().provider = ctx.blockchain_db().clone().with_tree(blockchain_tree);
debug!(target: "reth::cli", "configured blockchain tree");
// spawn exexs
let exex_manager_handle = ExExLauncher::new(
ctx.head(),
ctx.node_adapter().clone(),
installed_exex,
ctx.configs().clone(),
)
.launch()
.await?;
// create pipeline
let network_client = ctx.components().network().fetch_client().await?;
let (consensus_engine_tx, consensus_engine_rx) = unbounded_channel();
let node_config = ctx.node_config();
let consensus_engine_stream = UnboundedReceiverStream::from(consensus_engine_rx)
.maybe_skip_fcu(node_config.debug.skip_fcu)
.maybe_skip_new_payload(node_config.debug.skip_new_payload)
.maybe_reorg(
ctx.blockchain_db().clone(),
ctx.components().evm_config().clone(),
reth_payload_validator::ExecutionPayloadValidator::new(ctx.chain_spec()),
node_config.debug.reorg_frequency,
node_config.debug.reorg_depth,
)
// Store messages _after_ skipping so that `replay-engine` command
// would replay only the messages that were observed by the engine
// during this run.
.maybe_store_messages(node_config.debug.engine_api_store.clone());
let max_block = ctx.max_block(network_client.clone()).await?;
let mut hooks = EngineHooks::new();
let static_file_producer = ctx.static_file_producer();
let static_file_producer_events = static_file_producer.lock().events();
hooks.add(StaticFileHook::new(
static_file_producer.clone(),
Box::new(ctx.task_executor().clone()),
));
info!(target: "reth::cli", "StaticFileProducer initialized");
// Configure the pipeline
let pipeline_exex_handle =
exex_manager_handle.clone().unwrap_or_else(ExExManagerHandle::empty);
let (pipeline, client) = if ctx.is_dev() {
eyre::bail!("Dev mode is not supported for legacy engine")
} else {
let pipeline = crate::setup::build_networked_pipeline(
&ctx.toml_config().stages,
network_client.clone(),
consensus.clone(),
ctx.provider_factory().clone(),
ctx.task_executor(),
ctx.sync_metrics_tx(),
ctx.prune_config(),
max_block,
static_file_producer,
ctx.components().block_executor().clone(),
pipeline_exex_handle,
)?;
(pipeline, network_client.clone())
};
let pipeline_events = pipeline.events();
let initial_target = ctx.node_config().debug.tip;
let mut pruner_builder = ctx.pruner_builder();
if let Some(exex_manager_handle) = &exex_manager_handle {
pruner_builder =
pruner_builder.finished_exex_height(exex_manager_handle.finished_height());
}
let pruner = pruner_builder.build_with_provider_factory(ctx.provider_factory().clone());
let pruner_events = pruner.events();
info!(target: "reth::cli", prune_config=?ctx.prune_config().unwrap_or_default(), "Pruner initialized");
hooks.add(PruneHook::new(pruner, Box::new(ctx.task_executor().clone())));
// Configure the consensus engine
let (beacon_consensus_engine, beacon_engine_handle) = BeaconConsensusEngine::with_channel(
client,
pipeline,
ctx.blockchain_db().clone(),
Box::new(ctx.task_executor().clone()),
Box::new(ctx.components().network().clone()),
max_block,
ctx.components().payload_builder().clone(),
initial_target,
reth_beacon_consensus::MIN_BLOCKS_FOR_PIPELINE_RUN,
consensus_engine_tx,
Box::pin(consensus_engine_stream),
hooks,
)?;
info!(target: "reth::cli", "Consensus engine initialized");
let events = stream_select!(
pipeline_events.map(Into::<NodeEvent<Types::Primitives>>::into),
if ctx.node_config().debug.tip.is_none() && !ctx.is_dev() {
Either::Left(
ConsensusLayerHealthEvents::new(Box::new(ctx.blockchain_db().clone()))
.map(Into::into),
)
} else {
Either::Right(stream::empty())
},
pruner_events.map(Into::into),
static_file_producer_events.map(Into::into),
);
ctx.task_executor().spawn_critical(
"events task",
node::handle_events(
Some(Box::new(ctx.components().network().clone())),
Some(ctx.head().number),
events,
),
);
// extract the jwt secret from the args if possible
let jwt_secret = ctx.auth_jwt_secret()?;
let add_ons_ctx = AddOnsContext {
node: ctx.node_adapter().clone(),
config: ctx.node_config(),
beacon_engine_handle,
jwt_secret,
};
let RpcHandle { rpc_server_handles, rpc_registry } =
add_ons.launch_add_ons(add_ons_ctx).await?;
// Run consensus engine to completion
let (tx, rx) = oneshot::channel();
info!(target: "reth::cli", "Starting consensus engine");
ctx.task_executor().spawn_critical_blocking("consensus engine", async move {
let res = beacon_consensus_engine.await;
let _ = tx.send(res);
});
if let Some(maybe_custom_etherscan_url) = ctx.node_config().debug.etherscan.clone() {
info!(target: "reth::cli", "Using etherscan as consensus client");
let chain = ctx.node_config().chain.chain();
let etherscan_url = maybe_custom_etherscan_url.map(Ok).unwrap_or_else(|| {
// If URL isn't provided, use default Etherscan URL for the chain if it is known
chain
.etherscan_urls()
.map(|urls| urls.0.to_string())
.ok_or_else(|| eyre::eyre!("failed to get etherscan url for chain: {chain}"))
})?;
let block_provider = EtherscanBlockProvider::new(
etherscan_url,
chain.etherscan_api_key().ok_or_else(|| {
eyre::eyre!(
"etherscan api key not found for rpc consensus client for chain: {chain}"
)
})?,
);
let rpc_consensus_client = DebugConsensusClient::new(
rpc_server_handles.auth.clone(),
Arc::new(block_provider),
);
ctx.task_executor().spawn_critical("etherscan consensus client", async move {
rpc_consensus_client.run::<Types::Engine>().await
});
}
if let Some(rpc_ws_url) = ctx.node_config().debug.rpc_consensus_ws.clone() {
info!(target: "reth::cli", "Using rpc provider as consensus client");
let block_provider = RpcBlockProvider::new(rpc_ws_url);
let rpc_consensus_client = DebugConsensusClient::new(
rpc_server_handles.auth.clone(),
Arc::new(block_provider),
);
ctx.task_executor().spawn_critical("rpc consensus client", async move {
rpc_consensus_client.run::<Types::Engine>().await
});
}
let full_node = FullNode {
evm_config: ctx.components().evm_config().clone(),
block_executor: ctx.components().block_executor().clone(),
pool: ctx.components().pool().clone(),
network: ctx.components().network().clone(),
provider: ctx.node_adapter().provider.clone(),
payload_builder: ctx.components().payload_builder().clone(),
task_executor: ctx.task_executor().clone(),
config: ctx.node_config().clone(),
data_dir: ctx.data_dir().clone(),
add_ons_handle: RpcHandle { rpc_server_handles, rpc_registry },
};
// Notify on node started
on_node_started.on_event(FullNode::clone(&full_node))?;
let handle = NodeHandle {
node_exit_future: NodeExitFuture::new(
async { Ok(rx.await??) },
full_node.config.debug.terminate,
),
node: full_node,
};
Ok(handle)
}
}

View File

@ -13,6 +13,7 @@ reth-node-core.workspace = true
reth-payload-builder.workspace = true reth-payload-builder.workspace = true
reth-basic-payload-builder.workspace = true reth-basic-payload-builder.workspace = true
reth-ethereum-payload-builder.workspace = true reth-ethereum-payload-builder.workspace = true
reth-engine-local.workspace = true
reth-node-ethereum = { workspace = true, features = ["test-utils"] } reth-node-ethereum = { workspace = true, features = ["test-utils"] }
reth-tracing.workspace = true reth-tracing.workspace = true
reth-trie-db.workspace = true reth-trie-db.workspace = true

View File

@ -54,6 +54,7 @@ use reth_basic_payload_builder::{
PayloadBuilder, PayloadConfig, PayloadBuilder, PayloadConfig,
}; };
use reth_chainspec::{Chain, ChainSpec, ChainSpecProvider}; use reth_chainspec::{Chain, ChainSpec, ChainSpecProvider};
use reth_engine_local::payload::UnsupportedLocalAttributes;
use reth_ethereum_payload_builder::EthereumBuilderConfig; use reth_ethereum_payload_builder::EthereumBuilderConfig;
use reth_node_api::{ use reth_node_api::{
payload::{EngineApiMessageVersion, EngineObjectValidationError, PayloadOrAttributes}, payload::{EngineApiMessageVersion, EngineObjectValidationError, PayloadOrAttributes},
@ -88,6 +89,9 @@ pub struct CustomPayloadAttributes {
pub custom: u64, pub custom: u64,
} }
// TODO(mattsse): remove this tmp workaround
impl UnsupportedLocalAttributes for CustomPayloadAttributes {}
/// Custom error type used in payload attributes validation /// Custom error type used in payload attributes validation
#[derive(Debug, Error)] #[derive(Debug, Error)]
pub enum CustomError { pub enum CustomError {