Struct Geth

pub struct Geth { /* private fields */ }

Available on non-WebAssembly only.

Builder for launching geth.

Panics

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

Example

use ethers_core::utils::Geth;

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

let geth = Geth::new()
    .port(port)
    .block_time(5000u64)
    .spawn();

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

Implementations

impl Geth

pub fn new() -> Self

Creates an empty Geth builder.

The mnemonic is chosen randomly.

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

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

Example

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

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

pub fn is_clique(&self) -> bool

Returns whether the node is launched in Clique consensus mode

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 set_clique_private_key<T: Into<SigningKey>>(self, private_key: T) -> Self

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 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 fn block_time<T: Into<u64>>(self, block_time: T) -> Self

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

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

pub fn chain_id<T: Into<u64>>(self, chain_id: T) -> Self

Sets the chain id for the geth instance.

pub fn insecure_unlock(self) -> Self

Allow geth to unlock accounts when rpc apis are open.

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

Manually sets the IPC path for the socket manually.

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 fn authrpc_port(self, port: u16) -> Self

Sets the port for authenticated RPC connections.

pub fn spawn(self) -> GethInstance

Consumes the builder and spawns geth.

Panics

If spawning the instance fails at any point.

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.