Struct Reth 

pub struct Reth { /* private fields */ }

Builder for launching reth.

Panics

If spawn is called without reth being available in the user’s $PATH

Example

use alloy_node_bindings::Reth;

let port = 8545u16;
let url = format!("http://localhost:{}", port).to_string();

let reth = Reth::new().instance(1).block_time("12sec").spawn();

drop(reth); // this will kill the instance

Implementations

impl Reth

pub fn new() -> Self

Creates an empty Reth builder.

The instance number is set to a random number between 1 and 200 by default to reduce the odds of port conflicts. This can be changed with Reth::instance. Set to 0 to use the default ports. 200 is the maximum number of instances that can be run set by Reth.

pub fn at(path: impl Into<PathBuf>) -> Self

Creates a Reth builder which will execute reth at the given path.

Example

use alloy_node_bindings::Reth;
let reth = Reth::at("../reth/target/release/reth").spawn();

println!("Reth running at `{}`", reth.endpoint());

pub fn path<T: Into<PathBuf>>(self, path: T) -> Self

Sets the path to the reth executable

By default, it’s expected that reth is in $PATH, see also std::process::Command::new()

pub const fn dev(self) -> Self

Enable dev mode for the Reth instance.

pub fn host<T: Into<String>>(self, host: T) -> Self

Sets the host which will be used when the reth instance is launched.

Defaults to localhost.

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

Sets the HTTP port for the Reth instance. Note: this resets the instance number to 0 to allow for custom ports.

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

Sets the WS port for the Reth instance. Note: this resets the instance number to 0 to allow for custom ports.

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

Sets the auth port for the Reth instance. Note: this resets the instance number to 0 to allow for custom ports.

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

Sets the p2p port for the Reth instance. Note: this resets the instance number to 0 to allow for custom ports.

pub fn block_time(self, block_time: &str) -> Self

Sets the block time for the Reth instance. Parses strings using https://docs.rs/humantime/latest/humantime/fn.parse_duration.html This is only used if dev mode is enabled.

pub const fn disable_discovery(self) -> Self

Disables discovery for the Reth instance.

pub fn chain_or_path(self, chain_or_path: &str) -> Self

Sets the chain name or path to a chain spec for the Reth instance. Passed through to reth --chain <name-or-path>.

pub const fn enable_ipc(self) -> Self

Enable IPC for the Reth instance.

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

Sets the instance number for the Reth instance. Set to 0 to use the default ports. By default, a random number between 1 and 200 is used.

pub fn ipc_path<T: Into<PathBuf>>(self, path: T) -> Self

Sets the IPC path for the socket.

pub fn data_dir<T: Into<PathBuf>>(self, path: T) -> Self

Sets the data directory for reth.

pub fn genesis(self, genesis: Genesis) -> Self

Sets the genesis.json for the Reth instance.

If this is set, reth will be initialized with reth init and the --datadir option will be set to the same value as data_dir.

This is destructive and will overwrite any existing data in the data directory.

pub const fn keep_stdout(self) -> Self

Keep the handle to reth’s stdout in order to read from it.

Caution: if the stdout handle isn’t used, this can end up blocking.

pub fn arg<T: Into<OsString>>(self, arg: T) -> Self

Adds an argument to pass to reth.

Pass any arg that is not supported by the builder.

pub fn args<I, S>(self, args: I) -> Self

where I: IntoIterator<Item = S>, S: Into<OsString>,

Adds multiple arguments to pass to reth.

Pass any args that is not supported by the builder.

pub fn spawn(self) -> RethInstance

Consumes the builder and spawns reth.

Panics

If spawning the instance fails at any point.

pub fn try_spawn(self) -> Result<RethInstance, NodeError>

Consumes the builder and spawns reth. If spawning fails, returns an error.

Trait Implementations

impl Clone for Reth

fn clone(&self) -> Reth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reth

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

Formats the value using the given formatter.

impl Default for Reth

fn default() -> Reth

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