Struct MulticallBatch 

pub struct MulticallBatch { /* private fields */ }

A batch of calls to execute in a single aggregate3 invocation via Multicall3.

Build a batch with add / add_call, then run it with execute or execute_tracked. The batch should hold at most MAX_BATCH_SIZE calls; use execute_batched to chunk larger sets automatically.

Implementations

impl MulticallBatch

pub fn new() -> Self

Create a new empty batch.

use evm_fork_cache::multicall::MulticallBatch;

let batch = MulticallBatch::new();
assert!(batch.is_empty());
assert_eq!(batch.len(), 0);

pub fn with_capacity(capacity: usize) -> Self

Create a new empty batch with room for capacity calls before reallocating.

pub fn add( &mut self, target: Address, call_data: Bytes, allow_failure: bool, ) -> &mut Self

Add a call to the batch.

• target: The contract address to call
• call: The encoded call data
• allow_failure: If true, the call can fail without reverting the entire batch

pub fn add_call<C: SolCall>( &mut self, target: Address, call: C, allow_failure: bool, ) -> &mut Self

Add a typed SolCall to the batch, ABI-encoding its calldata.

Convenience wrapper over add for callers holding a generated call type rather than raw bytes. As with add, allow_failure controls whether a revert of this call fails the whole batch (false) or surfaces as success = false in the result (true).

pub fn len(&self) -> usize

Number of calls currently in the batch.

pub fn is_empty(&self) -> bool

Returns true if the batch contains no calls.

pub fn execute(&self, cache: &mut EvmCache) -> Result<Vec<Result>>

Execute the batch against cache, returning one IMulticall3::Result per input call, in order. An empty batch returns an empty vector without touching the EVM.

Per-call failure is reported in the result’s success field rather than as an Err: a call added with allow_failure = true that reverts surfaces as success = false with whatever revert data it returned. The batch as a whole is all-or-nothing — a call added with allow_failure = false that reverts makes the entire aggregate3 call revert, which is returned here as an Err.

Requires Multicall3 to be deployed at MULTICALL3_ADDRESS on the forked chain (it is on virtually all EVM chains).

Errors

Returns an error if:

• the underlying call_raw execution does not return ExecutionResult::Success — e.g. the aggregate3 call reverted because a call with allow_failure = false failed, or Multicall3 is not deployed; or
• the returned data cannot be ABI-decoded into the expected result list.

pub fn execute_tracked( &self, cache: &mut EvmCache, ) -> Result<(Vec<Result>, StorageAccessList)>

Execute the batch and return both the results and the StorageAccessList of all accounts/storage slots touched during execution.

Same all-or-nothing batch semantics and Multicall3 deployment requirement as execute, but uses call_raw_with_access_list to capture the EVM state touched by the multicall, enabling prefetch on the next cycle. An empty batch returns an empty result list and a default (empty) access list.

Errors

Returns an error under the same conditions as execute: the aggregate3 call did not succeed (revert, or Multicall3 not deployed), or the returned data failed to ABI-decode.

Trait Implementations

impl Default for MulticallBatch

fn default() -> Self

Returns the “default value” for a type.