1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
use futures::channel::oneshot::{channel, Sender};
use web3::{
error::Error as Web3Error,
helpers::{self},
types::{BlockId, BlockNumber, Bytes, CallRequest},
BatchTransport as Web3BatchTransport,
};
pub struct CallBatch<T: Web3BatchTransport> {
inner: T,
requests: Vec<(Request, CompletionHandler)>,
}
type Request = (CallRequest, Option<BlockId>);
type CompletionHandler = Sender<Result<Bytes, Web3Error>>;
impl<T: Web3BatchTransport> CallBatch<T> {
pub fn new(inner: T) -> Self {
Self {
inner,
requests: Default::default(),
}
}
pub fn push(
&mut self,
call: CallRequest,
block: Option<BlockId>,
) -> impl std::future::Future<Output = Result<Bytes, Web3Error>> {
let (tx, rx) = channel();
self.requests.push(((call, block), tx));
async move {
rx.await.unwrap_or_else(|_| {
Err(Web3Error::Transport(
"Batch has been dropped without executing".to_owned(),
))
})
}
}
pub async fn execute_all(self, batch_size: usize) {
let Self { inner, requests } = self;
let mut iterator = requests.into_iter().peekable();
while iterator.peek().is_some() {
let (requests, senders): (Vec<_>, Vec<_>) = iterator.by_ref().take(batch_size).unzip();
let batch_result = inner
.send_batch(requests.iter().map(|(request, block)| {
let req = helpers::serialize(request);
let block =
helpers::serialize(&block.unwrap_or_else(|| BlockNumber::Latest.into()));
let (id, request) = inner.prepare("eth_call", vec![req, block]);
(id, request)
}))
.await;
for (i, sender) in senders.into_iter().enumerate() {
let _ = match &batch_result {
Ok(results) => sender.send(
results
.get(i)
.unwrap_or(&Err(Web3Error::Decoder(
"Batch result did not contain enough responses".to_owned(),
)))
.clone()
.and_then(helpers::decode),
),
Err(err) => sender.send(Err(Web3Error::Transport(format!(
"Batch failed with: {}",
err
)))),
};
}
}
}
}
#[cfg(test)]
mod tests {
use futures::future::join_all;
use serde_json::json;
use super::*;
use crate::test::prelude::FutureTestExt;
use crate::test::transport::TestTransport;
#[test]
fn batches_calls() {
let mut transport = TestTransport::new();
transport.add_response(json!([json!("0x01"), json!("0x02")]));
let mut batch = CallBatch::new(transport);
let results = vec![
batch.push(CallRequest::default(), None),
batch.push(CallRequest::default(), None),
];
batch.execute_all(usize::MAX).immediate();
let results = join_all(results).immediate();
assert_eq!(results[0].clone().unwrap().0, vec![1u8]);
assert_eq!(results[1].clone().unwrap().0, vec![2u8]);
}
#[test]
fn resolves_calls_to_error_if_dropped() {
let future = {
let transport = TestTransport::new();
let mut batch = CallBatch::new(transport);
batch.push(CallRequest::default(), None)
};
assert!(matches!(
future.immediate().unwrap_err(),
Web3Error::Transport(_)
));
}
#[test]
fn fails_all_calls_if_batch_fails() {
let transport = TestTransport::new();
let mut batch = CallBatch::new(transport);
let call = batch.push(CallRequest::default(), None);
batch.execute_all(usize::MAX).immediate();
match call.immediate().unwrap_err() {
Web3Error::Transport(reason) => assert!(reason.starts_with("Batch failed with:")),
_ => panic!("Wrong Error type"),
};
}
#[test]
fn splits_batch_into_multiple_calls() {
let mut transport = TestTransport::new();
transport.add_response(json!([json!("0x01"), json!("0x02")]));
transport.add_response(json!([json!("0x03")]));
let mut batch = CallBatch::new(transport);
let results = vec![
batch.push(CallRequest::default(), None),
batch.push(CallRequest::default(), None),
batch.push(CallRequest::default(), None),
];
batch.execute_all(2).immediate();
let results = join_all(results).immediate();
assert_eq!(results[0].clone().unwrap().0, vec![1u8]);
assert_eq!(results[1].clone().unwrap().0, vec![2u8]);
assert_eq!(results[2].clone().unwrap().0, vec![3u8]);
}
}