Struct LaunchContextWith

pub struct LaunchContextWith<T> {
    pub inner: LaunchContext,
    pub attachment: T,
}

A LaunchContext along with an additional value.

This can be used to sequentially attach additional values to the type during the launch process.

The type provides common boilerplate for launching a node depending on the additional value.

Fields

inner: LaunchContext

The wrapped launch context.

attachment: T

The additional attached value.

Implementations

impl<T> LaunchContextWith<T>

pub fn configure_globals(&self)

Configure global settings this includes:

• Raising the file descriptor limit
• Configuring the global rayon thread pool

pub const fn data_dir(&self) -> &ChainPath<DataDirPath>

Returns the data directory.

pub const fn task_executor(&self) -> &TaskExecutor

Returns the task executor.

pub fn attach<A>(self, attachment: A) -> LaunchContextWith<Attached<T, A>>

Attaches another value to the launch context.

pub fn inspect<F>(self, f: F) -> LaunchContextWith<T>

where F: FnOnce(&LaunchContextWith<T>),

Consumes the type and calls a function with a reference to the context.

impl<ChainSpec> LaunchContextWith<WithConfigs<ChainSpec>>

pub async fn with_resolved_peers( self, ) -> Result<LaunchContextWith<WithConfigs<ChainSpec>>, Report>

Resolves the trusted peers and adds them to the toml config.

impl<L, R> LaunchContextWith<Attached<L, R>>

pub const fn left(&self) -> &L

Get a reference to the left value.

pub const fn right(&self) -> &R

Get a reference to the right value.

pub fn left_mut(&mut self) -> &mut L

Get a mutable reference to the right value.

pub fn right_mut(&mut self) -> &mut R

Get a mutable reference to the right value.

impl<R, ChainSpec> LaunchContextWith<Attached<WithConfigs<ChainSpec>, R>>

where ChainSpec: EthChainSpec,

pub fn with_adjusted_configs( self, ) -> LaunchContextWith<Attached<WithConfigs<ChainSpec>, R>>

Adjust certain settings in the config to make sure they are set correctly

This includes:

• Making sure the ETL dir is set to the datadir
• RPC settings are adjusted to the correct port

pub fn ensure_etl_datadir( self, ) -> LaunchContextWith<Attached<WithConfigs<ChainSpec>, R>>

Make sure ETL doesn’t default to /tmp/, but to whatever datadir is set to

pub fn with_adjusted_instance_ports( self, ) -> LaunchContextWith<Attached<WithConfigs<ChainSpec>, R>>

Change rpc port numbers based on the instance number.

pub const fn configs(&self) -> &WithConfigs<ChainSpec>

Returns the container for all config types

pub const fn node_config(&self) -> &NodeConfig<ChainSpec>

Returns the attached NodeConfig.

pub fn node_config_mut(&mut self) -> &mut NodeConfig<ChainSpec>

Returns the attached NodeConfig.

pub const fn toml_config(&self) -> &Config

Returns the attached toml config [reth_config::Config].

pub fn toml_config_mut(&mut self) -> &mut Config

Returns the attached toml config [reth_config::Config].

pub fn chain_spec(&self) -> Arc<ChainSpec>

Returns the configured chain spec.

pub fn genesis_hash(&self) -> FixedBytes<32>

Get the hash of the genesis block.

pub fn chain_id(&self) -> Chain

Returns the chain identifier of the node.

pub const fn is_dev(&self) -> bool

Returns true if the node is configured as –dev

pub fn prune_config(&self) -> Option<PruneConfig>

Returns the configured [PruneConfig] Any configuration set in CLI will take precedence over those set in toml

pub fn prune_modes(&self) -> PruneModes

Returns the configured [PruneModes], returning the default if no config was available.

pub fn pruner_builder(&self) -> PrunerBuilder

Returns an initialized [PrunerBuilder] based on the configured [PruneConfig]

pub fn auth_jwt_secret(&self) -> Result<JwtSecret, Report>

Loads the JWT secret for the engine API

pub fn dev_mining_mode(&self, pool: impl TransactionPool) -> MiningMode

Returns the MiningMode intended for –dev mode.

impl<DB, ChainSpec> LaunchContextWith<Attached<WithConfigs<ChainSpec>, DB>>

where DB: Database + Clone + 'static, ChainSpec: EthChainSpec + EthereumHardforks + 'static,

pub async fn create_provider_factory<N>( &self, ) -> Result<ProviderFactory<N>, Report>

where N: ProviderNodeTypes<DB = DB, ChainSpec = ChainSpec>, <N as NodeTypes>::Primitives: FullNodePrimitives<Block = Block, BlockBody = BlockBody>,

Returns the ProviderFactory for the attached storage after executing a consistent check between the database and static files. It may execute a pipeline unwind if it fails this check.

pub async fn with_provider_factory<N>( self, ) -> Result<LaunchContextWith<Attached<WithConfigs<ChainSpec>, ProviderFactory<N>>>, Report>

where N: ProviderNodeTypes<DB = DB, ChainSpec = ChainSpec>, <N as NodeTypes>::Primitives: FullNodePrimitives<Block = Block, BlockBody = BlockBody>,

Creates a new ProviderFactory and attaches it to the launch context.

impl<T> LaunchContextWith<Attached<WithConfigs<<T as NodeTypes>::ChainSpec>, ProviderFactory<T>>>

where T: ProviderNodeTypes,

pub const fn database(&self) -> &<T as NodeTypesWithDB>::DB

Returns access to the underlying database.

pub const fn provider_factory(&self) -> &ProviderFactory<T>

Returns the configured ProviderFactory.

pub fn static_file_provider( &self, ) -> StaticFileProvider<<T as NodeTypes>::Primitives>

Returns the static file provider to interact with the static files.

pub async fn with_prometheus_server( self, ) -> Result<LaunchContextWith<Attached<WithConfigs<<T as NodeTypes>::ChainSpec>, ProviderFactory<T>>>, Report>

This launches the prometheus endpoint.

Convenience function to Self::start_prometheus_endpoint

pub async fn start_prometheus_endpoint(&self) -> Result<(), Report>

Starts the prometheus endpoint.

pub fn with_genesis( self, ) -> Result<LaunchContextWith<Attached<WithConfigs<<T as NodeTypes>::ChainSpec>, ProviderFactory<T>>>, InitDatabaseError>

Convenience function to Self::init_genesis

pub fn init_genesis(&self) -> Result<FixedBytes<32>, InitDatabaseError>

Write the genesis block and state if it has not already been written

pub fn with_metrics_task( self, ) -> LaunchContextWith<Attached<WithConfigs<<T as NodeTypes>::ChainSpec>, WithMeteredProvider<T>>>

Creates a new WithMeteredProvider container and attaches it to the launch context.

This spawns a metrics task that listens for metrics related events and updates metrics for prometheus.

impl<N> LaunchContextWith<Attached<WithConfigs<<N as NodeTypes>::ChainSpec>, WithMeteredProvider<N>>>

where N: NodeTypesWithDB,

pub fn with_blockchain_db<T, F>( self, create_blockchain_provider: F, ) -> Result<LaunchContextWith<Attached<WithConfigs<<N as NodeTypes>::ChainSpec>, WithMeteredProviders<T>>>, Report>

where T: FullNodeTypes<Types = N>, F: FnOnce(ProviderFactory<N>) -> Result<<T as FullNodeTypes>::Provider, Report>,

Creates a BlockchainProvider and attaches it to the launch context.

impl<T> LaunchContextWith<Attached<WithConfigs<<<T as FullNodeTypes>::Types as NodeTypes>::ChainSpec>, WithMeteredProviders<T>>>

where T: FullNodeTypes, <T as FullNodeTypes>::Types: ProviderNodeTypes,

pub const fn database( &self, ) -> &<<T as FullNodeTypes>::Types as NodeTypesWithDB>::DB

Returns access to the underlying database.

pub const fn provider_factory( &self, ) -> &ProviderFactory<<T as FullNodeTypes>::Types>

Returns the configured ProviderFactory.

pub fn lookup_head(&self) -> Result<Head, Report>

Fetches the head block from the database.

If the database is empty, returns the genesis block.

pub fn sync_metrics_tx(&self) -> UnboundedSender<MetricEvent>

Returns the metrics sender.

pub const fn blockchain_db(&self) -> &<T as FullNodeTypes>::Provider

Returns a reference to the blockchain provider.

pub async fn with_components<CB>( self, components_builder: CB, on_component_initialized: Box<dyn OnComponentInitializedHook<NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>>>, ) -> Result<LaunchContextWith<Attached<WithConfigs<<<T as FullNodeTypes>::Types as NodeTypes>::ChainSpec>, WithComponents<T, CB>>>, Report>

where CB: NodeComponentsBuilder<T>,

Creates a NodeAdapter and attaches it to the launch context.

impl<T, CB> LaunchContextWith<Attached<WithConfigs<<<T as FullNodeTypes>::Types as NodeTypes>::ChainSpec>, WithComponents<T, CB>>>

where T: FullNodeTypes, <T as FullNodeTypes>::Types: ProviderNodeTypes, CB: NodeComponentsBuilder<T>,

pub const fn provider_factory( &self, ) -> &ProviderFactory<<T as FullNodeTypes>::Types>

Returns the configured ProviderFactory.

pub async fn max_block<C>(&self, client: C) -> Result<Option<u64>, Report>

where C: HeadersClient<Header = Header>,

Returns the max block that the node should run to, looking it up from the network if necessary

pub fn static_file_provider( &self, ) -> StaticFileProvider<<<T as FullNodeTypes>::Types as NodeTypes>::Primitives>

Returns the static file provider to interact with the static files.

pub fn static_file_producer( &self, ) -> StaticFileProducer<ProviderFactory<<T as FullNodeTypes>::Types>>

Creates a new [StaticFileProducer] with the attached database.

pub const fn head(&self) -> Head

Returns the current head block.

pub const fn node_adapter( &self, ) -> &NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>

Returns the configured NodeAdapter.

pub fn node_adapter_mut( &mut self, ) -> &mut NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>

Returns mutable reference to the configured NodeAdapter.

pub const fn blockchain_db(&self) -> &<T as FullNodeTypes>::Provider

Returns a reference to the blockchain provider.

pub fn initial_backfill_target( &self, ) -> Result<Option<FixedBytes<32>>, ProviderError>

Returns the initial backfill to sync to at launch.

This returns the configured debug.tip if set, otherwise it will check if backfill was previously interrupted and returns the block hash of the last checkpoint, see also Self::check_pipeline_consistency

pub const fn terminate_after_initial_backfill(&self) -> bool

Returns true if the node should terminate after the initial backfill run.

This is the case if any of these configs are set: --debug.max-block --debug.terminate

pub fn check_pipeline_consistency( &self, ) -> Result<Option<FixedBytes<32>>, ProviderError>

Check if the pipeline is consistent (all stages have the checkpoint block numbers no less than the checkpoint of the first stage).

This will return the pipeline target if:

• the pipeline was interrupted during its previous run
• a new stage was added
• stage data was dropped manually through reth stage drop ...

Returns

A target block hash if the pipeline is inconsistent, otherwise None.

pub fn consensus(&self) -> Arc<dyn Consensus>

Returns the configured Consensus.

pub fn sync_metrics_tx(&self) -> UnboundedSender<MetricEvent>

Returns the metrics sender.

pub const fn components(&self) -> &<CB as NodeComponentsBuilder<T>>::Components

Returns the node adapter components.

impl<T, CB> LaunchContextWith<Attached<WithConfigs<<<T as FullNodeTypes>::Types as NodeTypes>::ChainSpec>, WithComponents<T, CB>>>

where T: FullNodeTypes, <T as FullNodeTypes>::Provider: StateProviderFactory + ChainSpecProvider, <T as FullNodeTypes>::Types: ProviderNodeTypes, CB: NodeComponentsBuilder<T>,

pub fn invalid_block_hook(&self) -> Result<Box<dyn InvalidBlockHook>, Report>

Returns the InvalidBlockHook to use for the node.

Trait Implementations

impl<T> Clone for LaunchContextWith<T>

where T: Clone,

fn clone(&self) -> LaunchContextWith<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for LaunchContextWith<T>

where T: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.