reth_node_core::node_config

Struct NodeConfig

Source
pub struct NodeConfig<ChainSpec> {
Show 13 fields 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,
}
Expand description

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§

Source§

impl NodeConfig<ChainSpec>

Source

pub fn test() -> Self

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

Source§

impl<ChainSpec> NodeConfig<ChainSpec>

Source

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

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

Source

pub const fn dev(self) -> Self

Sets –dev mode for the node.

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

Source

pub const fn set_dev(self, dev: bool) -> Self

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

Source

pub fn with_datadir_args(self, datadir_args: DatadirArgs) -> Self

Set the data directory args for the node

Source

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

Set the config file for the node

Source

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

Set the [ChainSpec] for the node

Source

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

Set the metrics address for the node

Source

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

Set the instance for the node

Source

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

Set the network args for the node

Source

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

Set the rpc args for the node

Source

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

Set the txpool args for the node

Source

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

Set the builder args for the node

Source

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

Set the debug args for the node

Source

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

Set the database args for the node

Source

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

Set the dev args for the node

Source

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

Set the pruning args for the node

Source

pub fn prune_config(&self) -> Option<PruneConfig>
where ChainSpec: EthChainSpec,

Returns pruning configuration.

Source

pub async fn max_block<Provider, Client>( &self, network_client: Client, provider: Provider, ) -> Result<Option<BlockNumber>>
where Provider: HeaderProvider, Client: HeadersClient<Header: BlockHeader>,

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

Source

pub fn lookup_head<Factory>(&self, factory: &Factory) -> ProviderResult<Head>
where Factory: DatabaseProviderFactory<Provider: HeaderProvider + StageCheckpointReader + BlockHashReader>,

Fetches the head block from the database.

If the database is empty, returns the genesis block.

Source

pub async fn lookup_or_fetch_tip<Provider, Client>( &self, provider: Provider, client: Client, tip: B256, ) -> ProviderResult<u64>
where Provider: HeaderProvider, Client: 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.

Source

pub async fn fetch_tip_from_network<Client>( &self, client: Client, tip: BlockHashOrNumber, ) -> SealedHeader<Client::Header>
where Client: 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.

Source

pub fn adjust_instance_ports(&mut self)

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

Source

pub fn with_unused_ports(self) -> Self

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

Source

pub fn datadir(&self) -> ChainPath<DataDirPath>
where ChainSpec: EthChainSpec,

Resolve the final datadir path.

Source

pub fn load_path<T: Serialize + DeserializeOwned + Default>( path: impl AsRef<Path>, ) -> Result<T>

Load an application configuration from a specified path.

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

Source

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§

Source§

impl<ChainSpec> Clone for NodeConfig<ChainSpec>

Source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<ChainSpec: Debug> Debug for NodeConfig<ChainSpec>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for NodeConfig<ChainSpec>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<ChainSpec> Freeze for NodeConfig<ChainSpec>

§

impl<ChainSpec> RefUnwindSafe for NodeConfig<ChainSpec>
where ChainSpec: RefUnwindSafe,

§

impl<ChainSpec> Send for NodeConfig<ChainSpec>
where ChainSpec: Sync + Send,

§

impl<ChainSpec> Sync for NodeConfig<ChainSpec>
where ChainSpec: Sync + Send,

§

impl<ChainSpec> Unpin for NodeConfig<ChainSpec>

§

impl<ChainSpec> UnwindSafe for NodeConfig<ChainSpec>
where ChainSpec: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dst. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeDebug for T
where T: Debug,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSendSync for T

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