Struct alloy_zksync::node_bindings::AnvilZKsync

pub struct AnvilZKsync { /* private fields */ }

Builder for launching anvil-zksync.

Panics

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

Example

use alloy_zksync::node_bindings::AnvilZKsync;

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

let anvil_zksync = AnvilZKsync::new()
    .port(port)
    .spawn();

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

Implementations

impl AnvilZKsync

pub fn new() -> Self

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

Example

fn a() {
 let anvil_zksync = AnvilZKsync::default().spawn();

 println!("AnvilZKsync running at `{}`", anvil_zksync.endpoint());

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

Creates an AnvilZKsync builder which will execute anvil-zksync at the given path.

Example

fn a() {
 let anvil_zksync = AnvilZKsync::at("~/some/location/anvil-zksync").spawn();

 println!("AnvilZKsync running at `{}`", anvil_zksync.endpoint());

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

Sets the path to the anvil-zksync cli

By default, it’s expected that anvil-zksync 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-zksync instance is launched.

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

Sets the chain_id the anvil-zksync instance will use.

pub const fn no_mine(self) -> Self

Sets the no-mine status which will be used when the era_test_node instance is launched.

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

Sets the mnemonic which will be used when the anvil-zksync 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-zksync instance is launched.

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 arg<T: Into<String>>(self, arg: T) -> Self

Adds an argument to pass to the anvil-zksync.

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

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

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

pub fn spawn(self) -> AnvilZKsyncInstance

Consumes the builder and spawns anvil-zksync.

Panics

If spawning the instance fails at any point.

pub fn try_spawn(self) -> Result<AnvilZKsyncInstance, AnvilZKsyncError>

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

Trait Implementations

impl Clone for AnvilZKsync

fn clone(&self) -> AnvilZKsync

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnvilZKsync

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

Formats the value using the given formatter.

impl Default for AnvilZKsync

fn default() -> AnvilZKsync

Returns the “default value” for a type.

impl From<AnvilZKsync> for AnvilZKsyncLayer

fn from(anvil: AnvilZKsync) -> Self

Converts to this type from the input type.