Struct NodeConfig

pub struct NodeConfig<ChainSpec> {

    pub datadir: DatadirArgs,
    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() {
    // 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() {
    // 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

datadir: DatadirArgs

All data directory related arguments

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<ChainSpec>

pub fn test() -> NodeConfig<ChainSpec>

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

impl<ChainSpec> NodeConfig<ChainSpec>

pub fn new(chain: Arc<ChainSpec>) -> NodeConfig<ChainSpec>

Creates a new config with given chain spec, setting all fields to default values.

pub const fn dev(self) -> NodeConfig<ChainSpec>

Sets –dev mode for the node.

In addition to setting the --dev flag, this also:

• disables discovery in [NetworkArgs].

pub const fn set_dev(self, dev: bool) -> NodeConfig<ChainSpec>

Sets –dev mode for the node NodeConfig::dev, if dev is true.

pub fn with_datadir_args( self, datadir_args: DatadirArgs, ) -> NodeConfig<ChainSpec>

Set the data directory args for the node

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

Set the config file for the node

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

Set the [ChainSpec] for the node

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

Set the metrics address for the node

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

Set the instance for the node

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

Set the network args for the node

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

Set the rpc args for the node

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

Set the txpool args for the node

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

Set the builder args for the node

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

Set the debug args for the node

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

Set the database args for the node

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

Set the dev args for the node

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

Set the pruning args for the node

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

where ChainSpec: EthChainSpec,

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, <Client as HeadersClient>::Header: BlockHeader,

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

pub fn lookup_head<Factory>( &self, factory: &Factory, ) -> Result<Head, ProviderError>

where Factory: DatabaseProviderFactory, <Factory as DatabaseProviderFactory>::Provider: HeaderProvider + StageCheckpointReader + BlockHashReader,

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, ProviderError>

where Provider: HeaderProvider, Client: HeadersClient, <Client as HeadersClient>::Header: BlockHeader,

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: HashOrNumber, ) -> SealedHeader<<Client as HeadersClient>::Header>

where Client: HeadersClient, <Client as HeadersClient>::Header: BlockHeader,

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

NOTE: The download is attempted with infinite retries.

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<ChainSpec>

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

pub fn datadir(&self) -> ChainPath<DataDirPath>

where ChainSpec: EthChainSpec,

Resolve the final datadir path.

pub fn load_path<T>(path: impl AsRef<Path>) -> Result<T, Report>

where T: Serialize + DeserializeOwned + Default,

Load an application configuration from a specified path.

A new configuration file is created with default values if none exists.

pub fn map_chainspec<F, C>(self, f: F) -> NodeConfig<C>

where F: FnOnce(Arc<ChainSpec>) -> C,

Modifies the [ChainSpec] generic of the config using the provided closure.

Trait Implementations

impl<ChainSpec> Clone for NodeConfig<ChainSpec>

fn clone(&self) -> NodeConfig<ChainSpec>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<ChainSpec> Debug for NodeConfig<ChainSpec>

where ChainSpec: Debug,

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

Formats the value using the given formatter.

impl Default for NodeConfig<ChainSpec>

fn default() -> NodeConfig<ChainSpec>

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: 1792 bytes