alloy_provider/layers/
batch.rs

1use crate::{
2    bindings::IMulticall3, Caller, Provider, ProviderCall, ProviderLayer, RootProvider,
3    MULTICALL3_ADDRESS,
4};
5use alloy_eips::BlockId;
6use alloy_network::{Ethereum, Network, TransactionBuilder};
7use alloy_primitives::{Address, Bytes, U256};
8use alloy_rpc_client::WeakClient;
9use alloy_sol_types::{SolCall, SolType, SolValue};
10use alloy_transport::{utils::Spawnable, TransportErrorKind, TransportResult};
11use std::{fmt, future::IntoFuture, marker::PhantomData, sync::Arc, time::Duration};
12use tokio::sync::{mpsc, oneshot};
13
14#[cfg(target_family = "wasm")]
15use wasmtimer::tokio::sleep;
16
17#[cfg(not(target_family = "wasm"))]
18use tokio::time::sleep;
19
20/// This is chosen somewhat arbitrarily. It should be short enough to not cause a noticeable
21/// delay on individual requests, but long enough to allow for batching requests issued together in
22/// a short period of time, such as when using `join!` macro or similar future combinators.
23const DEFAULT_WAIT: Duration = Duration::from_millis(1);
24
25/// Provider layer that aggregates contract calls (`eth_call`) over a time period into a single
26/// [Multicall3] contract call.
27///
28/// Some methods, such as `eth_getBlockNumber`, are first converted into contract calls to the
29/// [Multicall3] contract itself and then aggregated with other `eth_call`s.
30///
31/// Only calls that:
32/// - target the latest block ID,
33/// - have no state overrides,
34/// - have a target address and calldata,
35/// - have no other properties (nonce, gas, etc.)
36///
37/// can be sent with a multicall. This of course requires that the [Multicall3] contract is
38/// deployed on the network, by default at [`MULTICALL3_ADDRESS`].
39///
40/// This layer is useful for reducing the number of network requests made.
41/// However, this only works when requests are made in parallel, for example when using the
42/// [`tokio::join!`] macro or in multiple threads/tasks, as otherwise the requests will be sent one
43/// by one as normal, but with an added delay.
44///
45/// # Examples
46///
47/// ```no_run
48/// use alloy_provider::{layers::CallBatchLayer, Provider, ProviderBuilder};
49/// use std::time::Duration;
50///
51/// # async fn f(url: &str) -> Result<(), Box<dyn std::error::Error>> {
52/// // Build a provider with the default call batching configuration.
53/// let provider = ProviderBuilder::new().with_call_batching().connect(url).await?;
54///
55/// // Build a provider with a custom call batching configuration.
56/// let provider = ProviderBuilder::new()
57///     .layer(CallBatchLayer::new().wait(Duration::from_millis(10)))
58///     .connect(url)
59///     .await?;
60///
61/// // Both of these requests will be batched together and only 1 network request will be made.
62/// let (block_number_result, chain_id_result) =
63///     tokio::join!(provider.get_block_number(), provider.get_chain_id());
64/// let block_number = block_number_result?;
65/// let chain_id = chain_id_result?;
66/// println!("block number: {block_number}, chain id: {chain_id}");
67/// # Ok(())
68/// # }
69/// ```
70///
71/// [Multicall3]: https://github.com/mds1/multicall3
72#[derive(Debug)]
73pub struct CallBatchLayer {
74    m3a: Address,
75    wait: Duration,
76}
77
78impl Default for CallBatchLayer {
79    fn default() -> Self {
80        Self::new()
81    }
82}
83
84impl CallBatchLayer {
85    /// Create a new `CallBatchLayer` with a default wait of 1ms.
86    pub const fn new() -> Self {
87        Self { m3a: MULTICALL3_ADDRESS, wait: DEFAULT_WAIT }
88    }
89
90    /// Set the amount of time to wait before sending the batch.
91    ///
92    /// This is the amount of time to wait after the first request is received before sending all
93    /// the requests received in that time period.
94    ///
95    /// This means that every request has a maximum delay of `wait` before being sent.
96    ///
97    /// The default is 1ms.
98    pub const fn wait(mut self, wait: Duration) -> Self {
99        self.wait = wait;
100        self
101    }
102
103    /// Set the multicall3 address.
104    ///
105    /// The default is [`MULTICALL3_ADDRESS`].
106    pub const fn multicall3_address(mut self, m3a: Address) -> Self {
107        self.m3a = m3a;
108        self
109    }
110}
111
112impl<P, N> ProviderLayer<P, N> for CallBatchLayer
113where
114    P: Provider<N> + 'static,
115    N: Network,
116{
117    type Provider = CallBatchProvider<P, N>;
118
119    fn layer(&self, inner: P) -> Self::Provider {
120        CallBatchProvider::new(inner, self)
121    }
122}
123
124type CallBatchMsgTx = TransportResult<IMulticall3::Result>;
125
126struct CallBatchMsg<N: Network> {
127    kind: CallBatchMsgKind<N>,
128    tx: oneshot::Sender<CallBatchMsgTx>,
129}
130
131impl<N: Network> Clone for CallBatchMsgKind<N>
132where
133    N::TransactionRequest: Clone,
134{
135    fn clone(&self) -> Self {
136        match self {
137            Self::Call(tx) => Self::Call(tx.clone()),
138            Self::BlockNumber => Self::BlockNumber,
139            Self::ChainId => Self::ChainId,
140            Self::Balance(addr) => Self::Balance(*addr),
141        }
142    }
143}
144
145impl<N: Network> fmt::Debug for CallBatchMsg<N> {
146    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
147        f.write_str("BatchProviderMessage(")?;
148        self.kind.fmt(f)?;
149        f.write_str(")")
150    }
151}
152
153#[derive(Debug)]
154enum CallBatchMsgKind<N: Network = Ethereum> {
155    Call(N::TransactionRequest),
156    BlockNumber,
157    ChainId,
158    Balance(Address),
159}
160
161impl<N: Network> CallBatchMsg<N> {
162    fn new(kind: CallBatchMsgKind<N>) -> (Self, oneshot::Receiver<CallBatchMsgTx>) {
163        let (tx, rx) = oneshot::channel();
164        (Self { kind, tx }, rx)
165    }
166}
167
168impl<N: Network> CallBatchMsgKind<N> {
169    fn to_call3(&self, m3a: Address) -> IMulticall3::Call3 {
170        let m3a_call = |data: Vec<u8>| IMulticall3::Call3 {
171            target: m3a,
172            allowFailure: true,
173            callData: data.into(),
174        };
175        match self {
176            Self::Call(tx) => IMulticall3::Call3 {
177                target: tx.to().unwrap_or_default(),
178                allowFailure: true,
179                callData: tx.input().cloned().unwrap_or_default(),
180            },
181            Self::BlockNumber => m3a_call(IMulticall3::getBlockNumberCall {}.abi_encode()),
182            Self::ChainId => m3a_call(IMulticall3::getChainIdCall {}.abi_encode()),
183            &Self::Balance(addr) => m3a_call(IMulticall3::getEthBalanceCall { addr }.abi_encode()),
184        }
185    }
186}
187
188/// A provider that batches multiple requests into a single request.
189///
190/// See [`CallBatchLayer`] for more information.
191pub struct CallBatchProvider<P, N: Network = Ethereum> {
192    provider: Arc<P>,
193    inner: CallBatchProviderInner<N>,
194    _pd: PhantomData<N>,
195}
196
197impl<P, N: Network> Clone for CallBatchProvider<P, N> {
198    fn clone(&self) -> Self {
199        Self { provider: self.provider.clone(), inner: self.inner.clone(), _pd: PhantomData }
200    }
201}
202
203impl<P: fmt::Debug, N: Network> fmt::Debug for CallBatchProvider<P, N> {
204    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
205        f.write_str("BatchProvider(")?;
206        self.provider.fmt(f)?;
207        f.write_str(")")
208    }
209}
210
211impl<P: Provider<N> + 'static, N: Network> CallBatchProvider<P, N> {
212    fn new(inner: P, layer: &CallBatchLayer) -> Self {
213        let inner = Arc::new(inner);
214        let tx = CallBatchBackend::spawn(inner.clone(), layer);
215        Self { provider: inner, inner: CallBatchProviderInner { tx }, _pd: PhantomData }
216    }
217}
218
219#[derive(Clone)]
220struct CallBatchProviderInner<N: Network> {
221    tx: mpsc::UnboundedSender<CallBatchMsg<N>>,
222}
223
224impl<N: Network> CallBatchProviderInner<N> {
225    /// We only want to perform a scheduled multicall if:
226    /// - The request has no block ID or state overrides,
227    /// - The request has a target address,
228    /// - The request has no other properties (`nonce`, `gas`, etc cannot be sent with a multicall).
229    ///
230    /// Ref: <https://github.com/wevm/viem/blob/ba8319f71503af8033fd3c77cfb64c7eb235c6a9/src/actions/public/call.ts#L295>
231    fn should_batch_call(&self, params: &crate::EthCallParams<N>) -> bool {
232        // TODO: block ID is not yet implemented
233        if params.block().is_some_and(|block| block != BlockId::latest()) {
234            return false;
235        }
236        if params.overrides.as_ref().is_some_and(|overrides| !overrides.is_empty()) {
237            return false;
238        }
239        let tx = params.data();
240        if tx.to().is_none() {
241            return false;
242        }
243        if let Ok(serde_json::Value::Object(obj)) = serde_json::to_value(tx) {
244            if obj.keys().any(|k| !matches!(k.as_str(), "to" | "data" | "input")) {
245                return false;
246            }
247        }
248        true
249    }
250
251    async fn schedule(self, msg: CallBatchMsgKind<N>) -> TransportResult<Bytes> {
252        let (msg, rx) = CallBatchMsg::new(msg);
253        self.tx.send(msg).map_err(|_| TransportErrorKind::backend_gone())?;
254
255        let IMulticall3::Result { success, returnData } =
256            rx.await.map_err(|_| TransportErrorKind::backend_gone())??;
257
258        if !success {
259            let revert_data = if returnData.is_empty() {
260                "".to_string()
261            } else {
262                format!(" with data: {returnData}")
263            };
264            Err(TransportErrorKind::custom_str(&format!(
265                "multicall batched call reverted{revert_data}"
266            )))
267        } else {
268            Ok(returnData)
269        }
270    }
271
272    async fn schedule_and_decode<T>(self, msg: CallBatchMsgKind<N>) -> TransportResult<T>
273    where
274        T: SolValue + From<<T::SolType as SolType>::RustType>,
275    {
276        let data = self.schedule(msg).await?;
277        T::abi_decode(&data).map_err(TransportErrorKind::custom)
278    }
279}
280
281struct CallBatchBackend<P, N: Network = Ethereum> {
282    inner: Arc<P>,
283    m3a: Address,
284    wait: Duration,
285    rx: mpsc::UnboundedReceiver<CallBatchMsg<N>>,
286    pending: Vec<CallBatchMsg<N>>,
287    _pd: PhantomData<N>,
288}
289
290impl<P: Provider<N> + 'static, N: Network> CallBatchBackend<P, N> {
291    fn spawn(inner: Arc<P>, layer: &CallBatchLayer) -> mpsc::UnboundedSender<CallBatchMsg<N>> {
292        let CallBatchLayer { m3a, wait } = *layer;
293        let (tx, rx) = mpsc::unbounded_channel();
294        let this = Self { inner, m3a, wait, rx, pending: Vec::new(), _pd: PhantomData };
295        this.run().spawn_task();
296        tx
297    }
298
299    async fn run(mut self) {
300        'outer: loop {
301            // Wait for the first message.
302            debug_assert!(self.pending.is_empty());
303            match self.rx.recv().await {
304                Some(msg) => self.process_msg(msg),
305                None => break,
306            }
307
308            // Handle all remaining messages after waiting the duration.
309            debug_assert!(!self.pending.is_empty());
310            sleep(self.wait).await;
311            'inner: loop {
312                match self.rx.try_recv() {
313                    Ok(msg) => self.process_msg(msg),
314                    Err(mpsc::error::TryRecvError::Empty) => break 'inner,
315                    Err(mpsc::error::TryRecvError::Disconnected) => break 'outer,
316                }
317            }
318            // No more messages, send the batch.
319            self.send_batch().await;
320        }
321    }
322
323    fn process_msg(&mut self, msg: CallBatchMsg<N>) {
324        self.pending.push(msg);
325    }
326
327    async fn send_batch(&mut self) {
328        let pending = std::mem::take(&mut self.pending);
329
330        // If there's only a single call, avoid batching and perform the request directly.
331        if pending.len() == 1 {
332            let msg = pending.into_iter().next().unwrap();
333            let result = self.call_one(msg.kind).await;
334            let _ = msg.tx.send(result);
335            return;
336        }
337
338        let result = self.send_batch_inner(&pending).await;
339        match result {
340            Ok(results) => {
341                debug_assert_eq!(results.len(), pending.len());
342                for (result, msg) in results.into_iter().zip(pending) {
343                    let _ = msg.tx.send(Ok(result));
344                }
345            }
346            Err(e) => {
347                for msg in pending {
348                    let _ = msg.tx.send(Err(TransportErrorKind::custom_str(&e.to_string())));
349                }
350            }
351        }
352    }
353
354    async fn call_one(&mut self, msg: CallBatchMsgKind<N>) -> TransportResult<IMulticall3::Result> {
355        let m3_res =
356            |success, return_data| IMulticall3::Result { success, returnData: return_data };
357        match msg {
358            CallBatchMsgKind::Call(tx) => self.inner.call(tx).await.map(|res| m3_res(true, res)),
359            CallBatchMsgKind::BlockNumber => {
360                self.inner.get_block_number().await.map(|res| m3_res(true, res.abi_encode().into()))
361            }
362            CallBatchMsgKind::ChainId => {
363                self.inner.get_chain_id().await.map(|res| m3_res(true, res.abi_encode().into()))
364            }
365            CallBatchMsgKind::Balance(addr) => {
366                self.inner.get_balance(addr).await.map(|res| m3_res(true, res.abi_encode().into()))
367            }
368        }
369    }
370
371    async fn send_batch_inner(
372        &self,
373        pending: &[CallBatchMsg<N>],
374    ) -> TransportResult<Vec<IMulticall3::Result>> {
375        let calls: Vec<_> = pending.iter().map(|msg| msg.kind.to_call3(self.m3a)).collect();
376
377        let tx = N::TransactionRequest::default()
378            .with_to(self.m3a)
379            .with_input(IMulticall3::aggregate3Call { calls }.abi_encode());
380
381        let bytes = self.inner.call(tx).await?;
382        if bytes.is_empty() {
383            return Err(TransportErrorKind::custom_str(&format!(
384                "Multicall3 not deployed at {}",
385                self.m3a
386            )));
387        }
388
389        let ret = IMulticall3::aggregate3Call::abi_decode_returns(&bytes)
390            .map_err(TransportErrorKind::custom)?;
391        Ok(ret)
392    }
393}
394
395impl<P: Provider<N> + 'static, N: Network> Provider<N> for CallBatchProvider<P, N> {
396    fn root(&self) -> &RootProvider<N> {
397        self.provider.root()
398    }
399
400    fn call(&self, tx: <N as Network>::TransactionRequest) -> crate::EthCall<N, Bytes> {
401        crate::EthCall::call(CallBatchCaller::new(self), tx)
402    }
403
404    fn get_block_number(
405        &self,
406    ) -> crate::ProviderCall<
407        alloy_rpc_client::NoParams,
408        alloy_primitives::U64,
409        alloy_primitives::BlockNumber,
410    > {
411        crate::ProviderCall::BoxedFuture(Box::pin(
412            self.inner.clone().schedule_and_decode::<u64>(CallBatchMsgKind::BlockNumber),
413        ))
414    }
415
416    fn get_chain_id(
417        &self,
418    ) -> crate::ProviderCall<
419        alloy_rpc_client::NoParams,
420        alloy_primitives::U64,
421        alloy_primitives::ChainId,
422    > {
423        crate::ProviderCall::BoxedFuture(Box::pin(
424            self.inner.clone().schedule_and_decode::<u64>(CallBatchMsgKind::ChainId),
425        ))
426    }
427
428    fn get_balance(&self, address: Address) -> crate::RpcWithBlock<Address, U256, U256> {
429        let this = self.clone();
430        crate::RpcWithBlock::new_provider(move |block| {
431            if block != BlockId::latest() {
432                this.provider.get_balance(address).block_id(block).into_future()
433            } else {
434                ProviderCall::BoxedFuture(Box::pin(
435                    this.inner
436                        .clone()
437                        .schedule_and_decode::<U256>(CallBatchMsgKind::Balance(address)),
438                ))
439            }
440        })
441    }
442}
443
444struct CallBatchCaller<N: Network> {
445    inner: CallBatchProviderInner<N>,
446    weak: WeakClient,
447}
448
449impl<N: Network> CallBatchCaller<N> {
450    fn new<P: Provider<N>>(provider: &CallBatchProvider<P, N>) -> Self {
451        Self { inner: provider.inner.clone(), weak: provider.provider.weak_client() }
452    }
453}
454
455impl<N: Network> Caller<N, Bytes> for CallBatchCaller<N> {
456    fn call(
457        &self,
458        params: crate::EthCallParams<N>,
459    ) -> TransportResult<crate::ProviderCall<crate::EthCallParams<N>, Bytes>> {
460        if !self.inner.should_batch_call(&params) {
461            return Caller::<N, Bytes>::call(&self.weak, params);
462        }
463
464        Ok(crate::ProviderCall::BoxedFuture(Box::pin(
465            self.inner.clone().schedule(CallBatchMsgKind::Call(params.into_data())),
466        )))
467    }
468
469    fn estimate_gas(
470        &self,
471        params: crate::EthCallParams<N>,
472    ) -> TransportResult<crate::ProviderCall<crate::EthCallParams<N>, Bytes>> {
473        Caller::<N, Bytes>::estimate_gas(&self.weak, params)
474    }
475
476    fn call_many(
477        &self,
478        params: crate::EthCallManyParams<'_>,
479    ) -> TransportResult<crate::ProviderCall<crate::EthCallManyParams<'static>, Bytes>> {
480        Caller::<N, Bytes>::call_many(&self.weak, params)
481    }
482}
483
484#[cfg(test)]
485mod tests {
486    use super::*;
487    use crate::ProviderBuilder;
488    use alloy_primitives::{address, hex};
489    use alloy_rpc_types_eth::TransactionRequest;
490    use alloy_transport::mock::Asserter;
491
492    // https://etherscan.io/address/0xcA11bde05977b3631167028862bE2a173976CA11#code
493    const MULTICALL3_DEPLOYED_CODE: &[u8] = &hex!("0x6080604052600436106100f35760003560e01c80634d2301cc1161008a578063a8b0574e11610059578063a8b0574e1461025a578063bce38bd714610275578063c3077fa914610288578063ee82ac5e1461029b57600080fd5b80634d2301cc146101ec57806372425d9d1461022157806382ad56cb1461023457806386d516e81461024757600080fd5b80633408e470116100c65780633408e47014610191578063399542e9146101a45780633e64a696146101c657806342cbb15c146101d957600080fd5b80630f28c97d146100f8578063174dea711461011a578063252dba421461013a57806327e86d6e1461015b575b600080fd5b34801561010457600080fd5b50425b6040519081526020015b60405180910390f35b61012d610128366004610a85565b6102ba565b6040516101119190610bbe565b61014d610148366004610a85565b6104ef565b604051610111929190610bd8565b34801561016757600080fd5b50437fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0140610107565b34801561019d57600080fd5b5046610107565b6101b76101b2366004610c60565b610690565b60405161011193929190610cba565b3480156101d257600080fd5b5048610107565b3480156101e557600080fd5b5043610107565b3480156101f857600080fd5b50610107610207366004610ce2565b73ffffffffffffffffffffffffffffffffffffffff163190565b34801561022d57600080fd5b5044610107565b61012d610242366004610a85565b6106ab565b34801561025357600080fd5b5045610107565b34801561026657600080fd5b50604051418152602001610111565b61012d610283366004610c60565b61085a565b6101b7610296366004610a85565b610a1a565b3480156102a757600080fd5b506101076102b6366004610d18565b4090565b60606000828067ffffffffffffffff8111156102d8576102d8610d31565b60405190808252806020026020018201604052801561031e57816020015b6040805180820190915260008152606060208201528152602001906001900390816102f65790505b5092503660005b8281101561047757600085828151811061034157610341610d60565b6020026020010151905087878381811061035d5761035d610d60565b905060200281019061036f9190610d8f565b6040810135958601959093506103886020850185610ce2565b73ffffffffffffffffffffffffffffffffffffffff16816103ac6060870187610dcd565b6040516103ba929190610e32565b60006040518083038185875af1925050503d80600081146103f7576040519150601f19603f3d011682016040523d82523d6000602084013e6103fc565b606091505b50602080850191909152901515808452908501351761046d577f08c379a000000000000000000000000000000000000000000000000000000000600052602060045260176024527f4d756c746963616c6c333a2063616c6c206661696c656400000000000000000060445260846000fd5b5050600101610325565b508234146104e6576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601a60248201527f4d756c746963616c6c333a2076616c7565206d69736d6174636800000000000060448201526064015b60405180910390fd5b50505092915050565b436060828067ffffffffffffffff81111561050c5761050c610d31565b60405190808252806020026020018201604052801561053f57816020015b606081526020019060019003908161052a5790505b5091503660005b8281101561068657600087878381811061056257610562610d60565b90506020028101906105749190610e42565b92506105836020840184610ce2565b73ffffffffffffffffffffffffffffffffffffffff166105a66020850185610dcd565b6040516105b4929190610e32565b6000604051808303816000865af19150503d80600081146105f1576040519150601f19603f3d011682016040523d82523d6000602084013e6105f6565b606091505b5086848151811061060957610609610d60565b602090810291909101015290508061067d576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601760248201527f4d756c746963616c6c333a2063616c6c206661696c656400000000000000000060448201526064016104dd565b50600101610546565b5050509250929050565b43804060606106a086868661085a565b905093509350939050565b6060818067ffffffffffffffff8111156106c7576106c7610d31565b60405190808252806020026020018201604052801561070d57816020015b6040805180820190915260008152606060208201528152602001906001900390816106e55790505b5091503660005b828110156104e657600084828151811061073057610730610d60565b6020026020010151905086868381811061074c5761074c610d60565b905060200281019061075e9190610e76565b925061076d6020840184610ce2565b73ffffffffffffffffffffffffffffffffffffffff166107906040850185610dcd565b60405161079e929190610e32565b6000604051808303816000865af19150503d80600081146107db576040519150601f19603f3d011682016040523d82523d6000602084013e6107e0565b606091505b506020808401919091529015158083529084013517610851577f08c379a000000000000000000000000000000000000000000000000000000000600052602060045260176024527f4d756c746963616c6c333a2063616c6c206661696c656400000000000000000060445260646000fd5b50600101610714565b6060818067ffffffffffffffff81111561087657610876610d31565b6040519080825280602002602001820160405280156108bc57816020015b6040805180820190915260008152606060208201528152602001906001900390816108945790505b5091503660005b82811015610a105760008482815181106108df576108df610d60565b602002602001015190508686838181106108fb576108fb610d60565b905060200281019061090d9190610e42565b925061091c6020840184610ce2565b73ffffffffffffffffffffffffffffffffffffffff1661093f6020850185610dcd565b60405161094d929190610e32565b6000604051808303816000865af19150503d806000811461098a576040519150601f19603f3d011682016040523d82523d6000602084013e61098f565b606091505b506020830152151581528715610a07578051610a07576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601760248201527f4d756c746963616c6c333a2063616c6c206661696c656400000000000000000060448201526064016104dd565b506001016108c3565b5050509392505050565b6000806060610a2b60018686610690565b919790965090945092505050565b60008083601f840112610a4b57600080fd5b50813567ffffffffffffffff811115610a6357600080fd5b6020830191508360208260051b8501011115610a7e57600080fd5b9250929050565b60008060208385031215610a9857600080fd5b823567ffffffffffffffff811115610aaf57600080fd5b610abb85828601610a39565b90969095509350505050565b6000815180845260005b81811015610aed57602081850181015186830182015201610ad1565b81811115610aff576000602083870101525b50601f017fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0169290920160200192915050565b600082825180855260208086019550808260051b84010181860160005b84811015610bb1578583037fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe001895281518051151584528401516040858501819052610b9d81860183610ac7565b9a86019a9450505090830190600101610b4f565b5090979650505050505050565b602081526000610bd16020830184610b32565b9392505050565b600060408201848352602060408185015281855180845260608601915060608160051b870101935082870160005b82811015610c52577fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffa0888703018452610c40868351610ac7565b95509284019290840190600101610c06565b509398975050505050505050565b600080600060408486031215610c7557600080fd5b83358015158114610c8557600080fd5b9250602084013567ffffffffffffffff811115610ca157600080fd5b610cad86828701610a39565b9497909650939450505050565b838152826020820152606060408201526000610cd96060830184610b32565b95945050505050565b600060208284031215610cf457600080fd5b813573ffffffffffffffffffffffffffffffffffffffff81168114610bd157600080fd5b600060208284031215610d2a57600080fd5b5035919050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052604160045260246000fd5b7f4e487b7100000000000000000000000000000000000000000000000000000000600052603260045260246000fd5b600082357fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff81833603018112610dc357600080fd5b9190910192915050565b60008083357fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe1843603018112610e0257600080fd5b83018035915067ffffffffffffffff821115610e1d57600080fd5b602001915036819003821315610a7e57600080fd5b8183823760009101908152919050565b600082357fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffc1833603018112610dc357600080fd5b600082357fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffa1833603018112610dc357600080fdfea2646970667358221220bb2b5c71a328032f97c676ae39a1ec2148d3e5d6f73d95e9b17910152d61f16264736f6c634300080c0033");
494    const COUNTER_ADDRESS: Address = address!("0x1234123412341234123412341234123412341234");
495    const COUNTER_DEPLOYED_CODE: &[u8] = &hex!("0x6080604052348015600e575f5ffd5b5060043610603a575f3560e01c80633fb5c1cb14603e5780638381f58a14604f578063d09de08a146068575b5f5ffd5b604d6049366004607d565b5f55565b005b60565f5481565b60405190815260200160405180910390f35b604d5f805490806076836093565b9190505550565b5f60208284031215608c575f5ffd5b5035919050565b5f6001820160af57634e487b7160e01b5f52601160045260245ffd5b506001019056fea2646970667358221220f423ff7a9a85bf49c3769164d3bd24403940510478df27a6b1deac980db69e5664736f6c634300081b0033");
496
497    fn push_m3_success(asserter: &Asserter, returns: &[(bool, Vec<u8>)]) {
498        asserter.push_success(
499            &returns
500                .iter()
501                .map(|&(success, ref data)| IMulticall3::Result {
502                    success,
503                    returnData: Bytes::copy_from_slice(data),
504                })
505                .collect::<Vec<_>>()
506                .abi_encode(),
507        )
508    }
509
510    #[tokio::test]
511    async fn basic_mocked() {
512        let asserter = Asserter::new();
513        let provider =
514            ProviderBuilder::new().with_call_batching().connect_mocked_client(asserter.clone());
515        push_m3_success(
516            &asserter,
517            &[
518                (true, 1.abi_encode()),  // IMulticall3::getBlockNumberCall
519                (true, 2.abi_encode()),  // IMulticall3::getChainIdCall
520                (false, 3.abi_encode()), // IMulticall3::getBlockNumberCall
521                (false, 4.abi_encode()), // IMulticall3::getChainIdCall
522            ],
523        );
524        let (block_number_ok, chain_id_ok, block_number_err, chain_id_err) = tokio::join!(
525            provider.get_block_number(),
526            provider.get_chain_id(),
527            provider.get_block_number(),
528            provider.get_chain_id(),
529        );
530        assert_eq!(block_number_ok.unwrap(), 1);
531        assert_eq!(chain_id_ok.unwrap(), 2);
532        assert!(block_number_err.unwrap_err().to_string().contains("reverted"));
533        assert!(chain_id_err.unwrap_err().to_string().contains("reverted"));
534        assert!(asserter.read_q().is_empty(), "only 1 request should've been made");
535    }
536
537    #[tokio::test]
538    #[cfg(feature = "anvil-api")]
539    async fn basic() {
540        use crate::ext::AnvilApi;
541        let provider = ProviderBuilder::new().with_call_batching().connect_anvil();
542        provider.anvil_set_code(COUNTER_ADDRESS, COUNTER_DEPLOYED_CODE.into()).await.unwrap();
543        provider.anvil_set_balance(COUNTER_ADDRESS, U256::from(123)).await.unwrap();
544
545        let do_calls = || async {
546            tokio::join!(
547                provider.call(
548                    TransactionRequest::default()
549                        .with_to(COUNTER_ADDRESS)
550                        .with_input(hex!("0x8381f58a")) // number()
551                ),
552                provider.call(
553                    TransactionRequest::default()
554                        .with_to(MULTICALL3_ADDRESS)
555                        .with_input(IMulticall3::getBlockNumberCall {}.abi_encode())
556                ),
557                provider.get_block_number(),
558                provider.get_chain_id(),
559                provider.get_balance(COUNTER_ADDRESS),
560            )
561        };
562
563        // Multicall3 has not yet been deployed.
564        let (a, b, c, d, e) = do_calls().await;
565        assert!(a.unwrap_err().to_string().contains("Multicall3 not deployed"));
566        assert!(b.unwrap_err().to_string().contains("Multicall3 not deployed"));
567        assert!(c.unwrap_err().to_string().contains("Multicall3 not deployed"));
568        assert!(d.unwrap_err().to_string().contains("Multicall3 not deployed"));
569        assert!(e.unwrap_err().to_string().contains("Multicall3 not deployed"));
570
571        provider.anvil_set_code(MULTICALL3_ADDRESS, MULTICALL3_DEPLOYED_CODE.into()).await.unwrap();
572
573        let (counter, block_number_raw, block_number, chain_id, balance) = do_calls().await;
574        assert_eq!(counter.unwrap(), 0u64.abi_encode());
575        assert_eq!(block_number_raw.unwrap(), 1u64.abi_encode());
576        assert_eq!(block_number.unwrap(), 1);
577        assert_eq!(chain_id.unwrap(), alloy_chains::NamedChain::AnvilHardhat as u64);
578        assert_eq!(balance.unwrap(), U256::from(123));
579    }
580}
alloy_provider/layers/batch.rs

alloy_provider/layers/
batch.rs
