//! Traits for configuring a node. use std::marker::PhantomData; use reth_db_api::{ database::Database, database_metrics::{DatabaseMetadata, DatabaseMetrics}, }; use reth_evm::execute::BlockExecutorProvider; use reth_network_api::FullNetwork; use reth_payload_builder::PayloadBuilderHandle; use reth_provider::FullProvider; use reth_tasks::TaskExecutor; use reth_transaction_pool::TransactionPool; use crate::{primitives::NodePrimitives, ConfigureEvm, EngineTypes}; /// The type that configures the essential types of an ethereum like node. /// /// This includes the primitive types of a node, the engine API types for communication with the /// consensus layer. /// /// This trait is intended to be stateless and only define the types of the node. pub trait NodeTypes: Send + Sync + Unpin + 'static { /// The node's primitive types, defining basic operations and structures. type Primitives: NodePrimitives; /// The node's engine types, defining the interaction with the consensus engine. type Engine: EngineTypes; } /// A [`NodeTypes`] type builder #[derive(Default, Debug)] pub struct AnyNodeTypes

(PhantomData

, PhantomData); impl AnyNodeTypes { /// Sets the `Primitives` associated type. pub const fn primitives(self) -> AnyNodeTypes { AnyNodeTypes::(PhantomData::, PhantomData::) } /// Sets the `Engine` associated type. pub const fn engine(self) -> AnyNodeTypes { AnyNodeTypes::(PhantomData::

, PhantomData::) } } impl NodeTypes for AnyNodeTypes where P: NodePrimitives + Send + Sync + Unpin + 'static, E: EngineTypes + Send + Sync + Unpin, { type Primitives = P; type Engine = E; } /// A helper trait that is downstream of the [`NodeTypes`] trait and adds stateful components to the /// node. /// /// Its types are configured by node internally and are not intended to be user configurable. pub trait FullNodeTypes: NodeTypes + 'static { /// Underlying database type used by the node to store and retrieve data. type DB: Database + DatabaseMetrics + DatabaseMetadata + Clone + Unpin + 'static; /// The provider type used to interact with the node. type Provider: FullProvider; } /// An adapter type that adds the builtin provider type to the user configured node types. #[derive(Debug)] pub struct FullNodeTypesAdapter { /// An instance of the user configured node types. pub types: PhantomData, /// The database type used by the node. pub db: PhantomData, /// The provider type used by the node. pub provider: PhantomData, } impl FullNodeTypesAdapter { /// Create a new adapter with the configured types. pub fn new() -> Self { Self { types: Default::default(), db: Default::default(), provider: Default::default() } } } impl Default for FullNodeTypesAdapter { fn default() -> Self { Self::new() } } impl Clone for FullNodeTypesAdapter { fn clone(&self) -> Self { Self { types: self.types, db: self.db, provider: self.provider } } } impl NodeTypes for FullNodeTypesAdapter where Types: NodeTypes, DB: Send + Sync + Unpin + 'static, Provider: Send + Sync + Unpin + 'static, { type Primitives = Types::Primitives; type Engine = Types::Engine; } impl FullNodeTypes for FullNodeTypesAdapter where Types: NodeTypes, Provider: FullProvider, DB: Database + DatabaseMetrics + DatabaseMetadata + Clone + Unpin + 'static, { type DB = DB; type Provider = Provider; } /// Encapsulates all types and components of the node. pub trait FullNodeComponents: FullNodeTypes + Clone + 'static { /// The transaction pool of the node. type Pool: TransactionPool + Unpin; /// The node's EVM configuration, defining settings for the Ethereum Virtual Machine. type Evm: ConfigureEvm; /// The type that knows how to execute blocks. type Executor: BlockExecutorProvider; /// Network API. type Network: FullNetwork; /// Returns the transaction pool of the node. fn pool(&self) -> &Self::Pool; /// Returns the node's evm config. fn evm_config(&self) -> &Self::Evm; /// Returns the node's executor type. fn block_executor(&self) -> &Self::Executor; /// Returns the provider of the node. fn provider(&self) -> &Self::Provider; /// Returns the handle to the network fn network(&self) -> &Self::Network; /// Returns the handle to the payload builder service. fn payload_builder(&self) -> &PayloadBuilderHandle; /// Returns handle to runtime. fn task_executor(&self) -> &TaskExecutor; } /// Customizable node add-on types. pub trait NodeAddOns: Send + Sync + Unpin + Clone + 'static { /// The core `eth` namespace API type to install on the RPC server (see /// `reth_rpc_eth_api::EthApiServer`). type EthApi: Send + Clone; } impl NodeAddOns for () { type EthApi = (); } /// Returns the builder for type. pub trait BuilderProvider: Send { /// Context required to build type. type Ctx<'a>; /// Returns builder for type. #[allow(clippy::type_complexity)] fn builder() -> Box Fn(Self::Ctx<'a>) -> Self + Send>; } impl BuilderProvider for () { type Ctx<'a> = (); fn builder() -> Box Fn(Self::Ctx<'a>) -> Self + Send> { Box::new(noop_builder) } } const fn noop_builder(_: ()) {}