Struct reth_node_builder::NodeConfig

pub struct NodeConfig {
    pub config: Option<PathBuf>,
    pub chain: Arc<ChainSpec>,
    pub metrics: Option<SocketAddr>,
    pub instance: u16,
    pub network: NetworkArgs,
    pub rpc: RpcServerArgs,
    pub txpool: TxPoolArgs,
    pub builder: PayloadBuilderArgs,
    pub debug: DebugArgs,
    pub db: DatabaseArgs,
    pub dev: DevArgs,
    pub pruning: PruningArgs,
}

This includes all necessary configuration to launch the node. The individual configuration options can be overwritten before launching the node.

Example

async fn t() {
    let handle = Handle::current();
    let manager = TaskManager::new(handle);
    let executor = manager.executor();

    // create the builder
    let builder = NodeConfig::default();

    // configure the rpc apis
    let mut rpc = RpcServerArgs::default().with_http().with_ws();
    rpc.http_api = Some(RpcModuleSelection::All);
    let builder = builder.with_rpc(rpc);
}

This can also be used to launch a node with a temporary test database. This can be done with the NodeConfig::test method.

Example

async fn t() {
    let handle = Handle::current();
    let manager = TaskManager::new(handle);
    let executor = manager.executor();

    // create the builder with a test database, using the `test` method
    let builder = NodeConfig::test();

    // configure the rpc apis
    let mut rpc = RpcServerArgs::default().with_http().with_ws();
    rpc.http_api = Some(RpcModuleSelection::All);
    let builder = builder.with_rpc(rpc);
}

Fields

config: Option<PathBuf>

The path to the configuration file to use.

chain: Arc<ChainSpec>

The chain this node is running.

Possible values are either a built-in chain or the path to a chain specification file.

metrics: Option<SocketAddr>

Enable Prometheus metrics.

The metrics will be served at the given interface and port.

instance: u16

Add a new instance of a node.

Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.

Max number of instances is 200. It is chosen in a way so that it’s not possible to have port numbers that conflict with each other.

Changes to the following port numbers:

• DISCOVERY_PORT: default + instance - 1
• DISCOVERY_V5_PORT: default + instance - 1
• AUTH_PORT: default + instance * 100 - 100
• HTTP_RPC_PORT: default - instance + 1
• WS_RPC_PORT: default + instance * 2 - 2

network: NetworkArgs

All networking related arguments

rpc: RpcServerArgs

All rpc related arguments

txpool: TxPoolArgs

All txpool related arguments with –txpool prefix

builder: PayloadBuilderArgs

All payload builder related arguments

debug: DebugArgs

All debug related arguments with –debug prefix

db: DatabaseArgs

All database related arguments

dev: DevArgs

All dev related arguments with –dev prefix

pruning: PruningArgs

All pruning related arguments

Implementations

impl NodeConfig

pub fn test() -> NodeConfig

Creates a testing NodeConfig, causing the database to be launched ephemerally.

pub const fn dev(self) -> NodeConfig

Sets –dev mode for the node

pub fn with_config(self, config: impl Into<PathBuf>) -> NodeConfig

Set the config file for the node

pub fn with_chain(self, chain: impl Into<Arc<ChainSpec>>) -> NodeConfig

Set the ChainSpec for the node

pub fn with_metrics(self, metrics: SocketAddr) -> NodeConfig

Set the metrics address for the node

pub fn with_instance(self, instance: u16) -> NodeConfig

Set the instance for the node

pub fn with_network(self, network: NetworkArgs) -> NodeConfig

Set the network args for the node

pub fn with_rpc(self, rpc: RpcServerArgs) -> NodeConfig

Set the rpc args for the node

pub fn with_txpool(self, txpool: TxPoolArgs) -> NodeConfig

Set the txpool args for the node

pub fn with_payload_builder(self, builder: PayloadBuilderArgs) -> NodeConfig

Set the builder args for the node

pub fn with_debug(self, debug: DebugArgs) -> NodeConfig

Set the debug args for the node

pub fn with_db(self, db: DatabaseArgs) -> NodeConfig

Set the database args for the node

pub fn with_dev(self, dev: DevArgs) -> NodeConfig

Set the dev args for the node

pub fn with_pruning(self, pruning: PruningArgs) -> NodeConfig

Set the pruning args for the node

pub fn network_secret( &self, data_dir: &ChainPath<DataDirPath> ) -> Result<SecretKey, Report>

Get the network secret from the given data dir

pub fn initial_pipeline_target( &self, genesis_hash: FixedBytes<32> ) -> Option<FixedBytes<32>>

Returns the initial pipeline target, based on whether or not the node is running in debug.tip mode, debug.continuous mode, or neither.

If running in debug.tip mode, the configured tip is returned. Otherwise, if running in debug.continuous mode, the genesis hash is returned. Otherwise, None is returned. This is what the node will do by default.

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

Returns pruning configuration.

pub async fn max_block<Provider, Client>( &self, network_client: Client, provider: Provider ) -> Result<Option<u64>, Report>

where Provider: HeaderProvider, Client: HeadersClient,

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

pub fn network_config<C>( &self, config: &Config, client: C, executor: TaskExecutor, head: Head, data_dir: &ChainPath<DataDirPath> ) -> Result<NetworkConfig<C>, Report>

Create the [NetworkConfig] for the node

pub async fn build_network<C>( &self, config: &Config, client: C, executor: TaskExecutor, head: Head, data_dir: &ChainPath<DataDirPath> ) -> Result<NetworkBuilder<C, (), ()>, Report>

where C: BlockNumReader,

Create the [NetworkBuilder].

This only configures it and does not spawn it.

pub fn kzg_settings(&self) -> Result<Arc<KZGSettings>, Report>

Loads ‘MAINNET_KZG_TRUSTED_SETUP’

pub fn install_prometheus_recorder(&self) -> Result<PrometheusHandle, Report>

Installs the prometheus recorder.

pub async fn start_metrics_endpoint<Metrics>( &self, prometheus_handle: PrometheusHandle, db: Metrics, static_file_provider: StaticFileProvider, task_executor: TaskExecutor ) -> Result<(), Report>

where Metrics: DatabaseMetrics + 'static + Send + Sync,

Serves the prometheus endpoint over HTTP with the given database and prometheus handle.

pub fn lookup_head<DB>( &self, factory: ProviderFactory<DB> ) -> Result<Head, RethError>

where DB: Database,

Fetches the head block from the database.

If the database is empty, returns the genesis block.

pub async fn lookup_or_fetch_tip<Provider, Client>( &self, provider: Provider, client: Client, tip: FixedBytes<32> ) -> Result<u64, RethError>

where Provider: HeaderProvider, Client: HeadersClient,

Attempt to look up the block number for the tip hash in the database. If it doesn’t exist, download the header and return the block number.

NOTE: The download is attempted with infinite retries.

pub async fn fetch_tip_from_network<Client>( &self, client: Client, tip: BlockHashOrNumber ) -> Result<SealedHeader, RethError>

where Client: HeadersClient,

Attempt to look up the block with the given number and return the header.

NOTE: The download is attempted with infinite retries.

pub fn load_network_config<C>( &self, config: &Config, client: C, executor: TaskExecutor, head: Head, secret_key: SecretKey, default_peers_path: PathBuf ) -> NetworkConfig<C>

Builds the [NetworkConfig] with the given ProviderFactory.

pub fn adjust_instance_ports(&mut self)

Change rpc port numbers based on the instance number, using the inner [RpcServerArgs::adjust_instance_ports] method.

pub fn with_unused_ports(self) -> NodeConfig

Sets networking and RPC ports to zero, causing the OS to choose random unused ports when sockets are bound.

Trait Implementations

impl Clone for NodeConfig

fn clone(&self) -> NodeConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeConfig

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

Formats the value using the given formatter.

impl Default for NodeConfig

fn default() -> NodeConfig

Returns the “default value” for a type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1088 bytes