Struct Anvil

pub struct Anvil { /* private fields */ }

Builder for launching anvil.

Panics

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

Example

use alloy_node_bindings::Anvil;

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

let anvil = Anvil::new()
    .port(port)
    .mnemonic("abstract vacuum mammal awkward pudding scene penalty purchase dinner depart evoke puzzle")
    .spawn();

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

Implementations

impl Anvil

pub fn new() -> Self

Creates an empty Anvil builder. The default port and the mnemonic are chosen randomly.

Example

fn a() {
 let anvil = Anvil::default().spawn();

 println!("Anvil running at `{}`", anvil.endpoint());

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

Creates an Anvil builder which will execute anvil at the given path.

Example

fn a() {
 let anvil = Anvil::at("~/.foundry/bin/anvil").spawn();

 println!("Anvil running at `{}`", anvil.endpoint());

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

Sets the path to the anvil cli

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

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

Sets the port which will be used when the anvil instance is launched.

pub fn ipc_path(self, path: impl Into<String>) -> Self

Sets the path for the ipc server

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

Sets the chain_id the anvil instance will use.

By default DEFAULT_IPC_ENDPOINT will be used.

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

Sets the mnemonic which will be used when the anvil instance is launched.

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

Sets the block-time in seconds which will be used when the anvil instance is launched.

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

Sets the block-time in sub-seconds which will be used when the anvil instance is launched. Older versions of anvil do not support sub-second block times.

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

Sets the fork-block-number which will be used in addition to Self::fork.

Note: if set, then this requires fork to be set as well

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

Sets the fork argument to fork from another currently running Ethereum client at a given block. Input should be the HTTP location and port of the other client, e.g. http://localhost:8545. You can optionally specify the block to fork from using an @ sign: http://localhost:8545@1599200

pub fn hardfork(self, hardfork: EthereumHardfork) -> Self

Select the EthereumHardfork to start anvil with.

pub fn paris(self) -> Self

Set the EthereumHardfork to EthereumHardfork::Paris.

pub fn cancun(self) -> Self

Set the EthereumHardfork to EthereumHardfork::Cancun.

pub fn shanghai(self) -> Self

Set the EthereumHardfork to EthereumHardfork::Shanghai.

pub fn prague(self) -> Self

Set the EthereumHardfork to EthereumHardfork::Prague.

pub fn odyssey(self) -> Self

Instantiate anvil with the --odyssey flag.

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

Adds an argument to pass to the anvil.

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

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

Adds an argument to pass to the anvil.

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

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

Adds multiple arguments to pass to the anvil.

pub fn env<K, V>(self, key: K, value: V) -> Self

where K: Into<OsString>, V: Into<OsString>,

Adds an environment variable to pass to the anvil.

pub fn envs<I, K, V>(self, envs: I) -> Self

where I: IntoIterator<Item = (K, V)>, K: Into<OsString>, V: Into<OsString>,

Adds multiple environment variables to pass to the anvil.

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

Sets the timeout which will be used when the anvil instance is launched.

pub const fn keep_stdout(self) -> Self

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

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

pub fn spawn(self) -> AnvilInstance

Consumes the builder and spawns anvil.

Panics

If spawning the instance fails at any point.

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

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

Trait Implementations

impl Clone for Anvil

fn clone(&self) -> Anvil

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Anvil

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

Formats the value using the given formatter.

impl Default for Anvil

fn default() -> Anvil

Returns the “default value” for a type.