Struct ethers_core::utils::Anvil

source ·
pub struct Anvil { /* private fields */ }
Available on non-WebAssembly only.
Expand description

Builder for launching anvil.

§Panics

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

§Example

use ethers_core::utils::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§

source§

impl Anvil

source

pub fn new() -> Self

Creates an empty Anvil builder. The default port is 8545. The mnemonic is chosen randomly.

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

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

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());
source

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()

source

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

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

source

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

Sets the chain_id the anvil instance will use.

source

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

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

source

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

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

source

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

source

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

source

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

Adds an argument to pass to the anvil.

source

pub fn args<I, S>(self, args: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Adds multiple arguments to pass to the anvil.

source

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

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

source

pub fn spawn(self) -> AnvilInstance

Consumes the builder and spawns anvil.

§Panics

If spawning the instance fails at any point.

Trait Implementations§

source§

impl Clone for Anvil

source§

fn clone(&self) -> Anvil

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 Debug for Anvil

source§

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

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

impl Default for Anvil

source§

fn default() -> Anvil

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

Auto Trait Implementations§

§

impl RefUnwindSafe for Anvil

§

impl Send for Anvil

§

impl Sync for Anvil

§

impl Unpin for Anvil

§

impl UnwindSafe for Anvil

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

§

type Output = T

Should always be Self
source§

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

§

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
source§

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

§

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>,

§

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.
source§

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

source§

fn vzip(self) -> V

source§

impl<T> JsonSchemaMaybe for T