Struct Geth 

pub struct Geth { /* private fields */ }

Builder for launching geth.

The default mode is an isolated development chain. Geth::p2p_port and Geth::disable_discovery switch to non-dev mode; Geth::dev and Geth::block_time switch back to dev mode. Geth::spawn panics on any startup failure; use Geth::try_spawn to handle errors.

Example

use alloy_node_bindings::Geth;

let geth = Geth::new().block_time(1).try_spawn()?;
println!("Geth is listening at {}", geth.endpoint());

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

Implementations

impl Geth

pub fn new() -> Self

Creates a Geth builder in dev mode.

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

Creates a Geth builder which will execute geth at the given path.

Example

use alloy_node_bindings::Geth;
let geth = Geth::at("../go-ethereum/build/bin/geth").spawn();

println!("Geth running at `{}`", geth.endpoint());

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

Sets the path to the geth executable

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

pub fn dev(self) -> Self

Puts the geth instance in dev mode.

pub const fn is_clique(&self) -> bool

Returns whether the node is launched in Clique consensus mode.

pub fn clique_address(&self) -> Option<Address>

Calculates the address of the Clique consensus address.

pub fn set_clique_private_key<T: Into<SigningKey>>(self, private_key: T) -> Self

👎Deprecated:

clique support was removed in geth >=1.14

Sets the Clique Private Key to the geth executable, which will be later loaded on the node.

The address derived from this private key will be used to set the miner.etherbase field on the node.

pub fn port<T: Into<u16>>(self, port: T) -> Self

Sets the port which will be used when the geth-cli instance is launched.

If port is 0 then the OS will choose a random port. GethInstance::port will return the port that was chosen.

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

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

Defaults to localhost.

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

Sets the port which will be used for incoming p2p connections.

This will put the geth instance into non-dev mode, discarding any previously set dev-mode options.

pub const fn block_time(self, block_time: u64) -> Self

Sets the dev-chain block interval in seconds.

This will put the geth instance in dev mode, discarding any previously set options that cannot be used in dev mode.

pub const fn chain_id(self, chain_id: u64) -> Self

Sets the chain id for the geth instance.

pub const fn insecure_unlock(self) -> Self

Allow geth to unlock accounts when rpc apis are open.

pub const fn enable_ipc(self) -> Self

Enable IPC for the geth instance.

pub fn disable_discovery(self) -> Self

Disable discovery for the geth instance.

This will put the geth instance into non-dev mode, discarding any previously set dev-mode options.

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

Sets the IPC path for the socket.

This also enables IPC, as setting a path implies the intent to use IPC.

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

Sets the data directory for geth.

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

Sets the genesis.json for the geth instance.

If this is set, geth will be initialized with geth 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 authrpc_port(self, port: u16) -> Self

Sets the port for authenticated RPC connections.

pub const fn keep_stderr(self) -> Self

Keep the handle to geth’s stderr in order to read from it.

This is required by GethInstance::stderr and GethInstance::wait_to_add_peer. Caution: if the stderr handle is not continuously consumed, the child process can block.

pub fn push_arg<T: Into<OsString>>(&mut self, arg: T)

Adds an argument to pass to the geth.

pub fn extend_args<I, S>(&mut self, args: I)

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

Adds multiple arguments to pass to the geth.

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

Adds an argument to pass to geth.

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 geth.

Pass any args that is not supported by the builder.

pub fn spawn(self) -> GethInstance

Consumes the builder and spawns geth.

Panics

If spawning the instance fails at any point.

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

Consumes the builder, spawns geth, and waits for its HTTP and active networking services to report ready.

Returns an error if the process cannot be started, reports a fatal startup error, or does not become ready before NODE_STARTUP_TIMEOUT is observed. The deadline is checked between complete stderr lines; a live process that emits no newline can block this call past the deadline.

Trait Implementations

impl Clone for Geth

fn clone(&self) -> Geth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Geth

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

Formats the value using the given formatter.

impl Default for Geth

fn default() -> Geth

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