Struct NodeHandle

pub struct NodeHandle {
    pub(crate) config: NodeConfig,
    pub(crate) addresses: Vec<SocketAddr>,
    pub node_service: JoinHandle<Result<(), NodeError>>,
    pub servers: Vec<JoinHandle<Result<(), NodeError>>>,
    pub(crate) ipc_task: Option<JoinHandle<()>>,
    pub(crate) _signal: Option<Signal>,
    pub(crate) task_manager: TaskManager,
}

A handle to the spawned node and server tasks.

This future will resolve if either the node or server task resolve/fail.

Fields

config: NodeConfig

addresses: Vec<SocketAddr>

The address of the running rpc server.

node_service: JoinHandle<Result<(), NodeError>>

Join handle for the Node Service.

servers: Vec<JoinHandle<Result<(), NodeError>>>

Join handles (one per socket) for the Anvil server.

ipc_task: Option<JoinHandle<()>>

The future that joins the ipc server, if any.

_signal: Option<Signal>

A signal that fires the shutdown, fired on drop.

task_manager: TaskManager

A task manager that can be used to spawn additional tasks.

Implementations

impl NodeHandle

pub fn config(&self) -> &NodeConfig

The NodeConfig the node was launched with.

pub(crate) fn print(&self, fork: Option<&ClientFork>)

Prints the launch info.

pub fn socket_address(&self) -> &SocketAddr

The address of the launched server.

N.B. this may not necessarily be the same host + port as configured in the NodeConfig, if port was set to 0, then the OS auto picks an available port.

pub fn http_endpoint(&self) -> String

Returns the http endpoint.

pub fn ws_endpoint(&self) -> String

Returns the websocket endpoint.

pub fn ipc_path(&self) -> Option<String>

Returns the path of the launched ipc server, if any.

pub fn http_provider(&self) -> RetryProvider

Constructs a [RetryProvider] for this handle’s HTTP endpoint.

pub fn ws_provider(&self) -> RetryProvider

Constructs a [RetryProvider] for this handle’s WS endpoint.

pub fn ipc_provider(&self) -> Option<RetryProvider>

Constructs a [RetryProvider] for this handle’s IPC endpoint, if any.

pub fn dev_accounts(&self) -> impl Iterator<Item = Address> + '_

Signer accounts that can sign messages/transactions from the EVM node.

pub fn dev_wallets(&self) -> impl Iterator<Item = PrivateKeySigner> + '_

Signer accounts that can sign messages/transactions from the EVM node.

pub fn genesis_accounts(&self) -> impl Iterator<Item = Address> + '_

Accounts that will be initialised with genesis_balance in the genesis block.

pub fn genesis_balance(&self) -> U256

Native token balance of every genesis account in the genesis block.

pub fn gas_price(&self) -> u128

Default gas price for all txs.

pub fn shutdown_signal(&self) -> &Option<Signal>

Returns the shutdown signal.

pub fn shutdown_signal_mut(&mut self) -> &mut Option<Signal>

Returns mutable access to the shutdown signal.

This can be used to extract the Signal.

pub fn task_manager(&self) -> &TaskManager

Returns the task manager that can be used to spawn new tasks.

use anvil::NodeHandle;
let task_manager = handle.task_manager();
let on_shutdown = task_manager.on_shutdown();

task_manager.spawn(async move {
    on_shutdown.await;
    // do something
});

Trait Implementations

impl Drop for NodeHandle

fn drop(&mut self)

Executes the destructor for this type.

impl Future for NodeHandle

type Output = Result<Result<(), NodeError>, JoinError>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

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