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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
use std::sync::Arc;
use chain::{IndexedBlock, IndexedTransaction};
use message::common::InventoryVector;
use message::types;
use synchronization_peers::{BlockAnnouncementType, TransactionAnnouncementType};
use types::{PeerIndex, PeersRef, RequestId};
use utils::KnownHashType;
pub trait TaskExecutor : Send + Sync + 'static {
fn execute(&self, task: Task);
}
#[derive(Debug, PartialEq)]
pub enum Task {
Ignore(PeerIndex, RequestId),
GetData(PeerIndex, types::GetData),
GetHeaders(PeerIndex, types::GetHeaders),
MemoryPool(PeerIndex),
Block(PeerIndex, IndexedBlock),
MerkleBlock(PeerIndex, types::MerkleBlock),
CompactBlock(PeerIndex, types::CompactBlock),
WitnessBlock(PeerIndex, IndexedBlock),
Transaction(PeerIndex, IndexedTransaction),
WitnessTransaction(PeerIndex, IndexedTransaction),
BlockTxn(PeerIndex, types::BlockTxn),
NotFound(PeerIndex, types::NotFound),
Inventory(PeerIndex, types::Inv),
Headers(PeerIndex, types::Headers, Option<RequestId>),
RelayNewBlock(IndexedBlock),
RelayNewTransaction(IndexedTransaction, u64),
}
pub struct LocalSynchronizationTaskExecutor {
peers: PeersRef,
}
impl LocalSynchronizationTaskExecutor {
pub fn new(peers: PeersRef) -> Arc<Self> {
Arc::new(LocalSynchronizationTaskExecutor {
peers: peers,
})
}
fn execute_ignore(&self, peer_index: PeerIndex, request_id: RequestId) {
if let Some(connection) = self.peers.connection(peer_index) {
trace!(target: "sync", "Ignoring request {} from peer#{}", request_id, peer_index);
connection.ignored(request_id);
}
}
fn execute_getdata(&self, peer_index: PeerIndex, getdata: types::GetData) {
if let Some(connection) = self.peers.connection(peer_index) {
trace!(target: "sync", "Querying {} unknown items from peer#{}", getdata.inventory.len(), peer_index);
connection.send_getdata(&getdata);
}
}
fn execute_getheaders(&self, peer_index: PeerIndex, getheaders: types::GetHeaders) {
if let Some(connection) = self.peers.connection(peer_index) {
if !getheaders.block_locator_hashes.is_empty() {
trace!(target: "sync", "Querying headers starting with {} unknown items from peer#{}", getheaders.block_locator_hashes[0].to_reversed_str(), peer_index);
}
connection.send_getheaders(&getheaders);
}
}
fn execute_memorypool(&self, peer_index: PeerIndex) {
if let Some(connection) = self.peers.connection(peer_index) {
trace!(target: "sync", "Querying memory pool contents from peer#{}", peer_index);
let mempool = types::MemPool;
connection.send_mempool(&mempool);
}
}
fn execute_block(&self, peer_index: PeerIndex, block: IndexedBlock) {
if let Some(connection) = self.peers.connection(peer_index) {
trace!(target: "sync", "Sending block {} to peer#{}", block.hash().to_reversed_str(), peer_index);
self.peers.hash_known_as(peer_index, block.hash().clone(), KnownHashType::Block);
let block = types::Block {
block: block.to_raw_block(),
};
connection.send_block(&block);
}
}
fn execute_merkleblock(&self, peer_index: PeerIndex, block: types::MerkleBlock) {
if let Some(connection) = self.peers.connection(peer_index) {
let hash = block.block_header.hash();
trace!(target: "sync", "Sending merkle block {} to peer#{}", hash.to_reversed_str(), peer_index);
self.peers.hash_known_as(peer_index, hash, KnownHashType::Block);
connection.send_merkleblock(&block);
}
}
fn execute_compact_block(&self, peer_index: PeerIndex, block: types::CompactBlock) {
if let Some(connection) = self.peers.connection(peer_index) {
let hash = block.header.header.hash();
trace!(target: "sync", "Sending compact block {} to peer#{}", hash.to_reversed_str(), peer_index);
self.peers.hash_known_as(peer_index, hash, KnownHashType::CompactBlock);
connection.send_compact_block(&block);
}
}
fn execute_witness_block(&self, peer_index: PeerIndex, block: IndexedBlock) {
if let Some(connection) = self.peers.connection(peer_index) {
trace!(target: "sync", "Sending witness block {} to peer#{}", block.hash().to_reversed_str(), peer_index);
self.peers.hash_known_as(peer_index, block.hash().clone(), KnownHashType::Block);
let block = types::Block {
block: block.to_raw_block(),
};
connection.send_witness_block(&block);
}
}
fn execute_transaction(&self, peer_index: PeerIndex, transaction: IndexedTransaction) {
if let Some(connection) = self.peers.connection(peer_index) {
trace!(target: "sync", "Sending transaction {} to peer#{}", transaction.hash.to_reversed_str(), peer_index);
self.peers.hash_known_as(peer_index, transaction.hash, KnownHashType::Transaction);
let transaction = types::Tx {
transaction: transaction.raw,
};
connection.send_transaction(&transaction);
}
}
fn execute_witness_transaction(&self, peer_index: PeerIndex, transaction: IndexedTransaction) {
if let Some(connection) = self.peers.connection(peer_index) {
trace!(target: "sync", "Sending witness transaction {} to peer#{}", transaction.hash.to_reversed_str(), peer_index);
self.peers.hash_known_as(peer_index, transaction.hash, KnownHashType::Transaction);
let transaction = types::Tx {
transaction: transaction.raw,
};
connection.send_witness_transaction(&transaction);
}
}
fn execute_block_txn(&self, peer_index: PeerIndex, blocktxn: types::BlockTxn) {
if let Some(connection) = self.peers.connection(peer_index) {
trace!(target: "sync", "Sending blocktxn with {} transactions to peer#{}", blocktxn.request.transactions.len(), peer_index);
connection.send_block_txn(&blocktxn);
}
}
fn execute_notfound(&self, peer_index: PeerIndex, notfound: types::NotFound) {
if let Some(connection) = self.peers.connection(peer_index) {
trace!(target: "sync", "Sending notfound to peer#{} with {} items", peer_index, notfound.inventory.len());
connection.send_notfound(¬found);
}
}
fn execute_inventory(&self, peer_index: PeerIndex, inventory: types::Inv) {
if let Some(connection) = self.peers.connection(peer_index) {
trace!(target: "sync", "Sending inventory to peer#{} with {} items", peer_index, inventory.inventory.len());
connection.send_inventory(&inventory);
}
}
fn execute_headers(&self, peer_index: PeerIndex, headers: types::Headers, request_id: Option<RequestId>) {
if let Some(connection) = self.peers.connection(peer_index) {
trace!(target: "sync", "Sending headers to peer#{} with {} items", peer_index, headers.headers.len());
match request_id {
Some(request_id) => connection.respond_headers(&headers, request_id),
None => connection.send_headers(&headers),
}
}
}
fn execute_relay_block(&self, block: IndexedBlock) {
for peer_index in self.peers.enumerate() {
match self.peers.filter_block(peer_index, &block) {
BlockAnnouncementType::SendInventory => {
self.execute_inventory(peer_index, types::Inv::with_inventory(vec![
InventoryVector::block(block.hash().clone()),
]));
},
BlockAnnouncementType::SendHeaders => {
self.execute_headers(peer_index, types::Headers::with_headers(vec![
block.header.raw.clone(),
]), None);
},
BlockAnnouncementType::SendCompactBlock => if let Some(compact_block) = self.peers.build_compact_block(peer_index, &block) {
self.execute_compact_block(peer_index, compact_block);
},
BlockAnnouncementType::DoNotAnnounce => (),
}
}
}
fn execute_relay_transaction(&self, transaction: IndexedTransaction, fee_rate: u64) {
for peer_index in self.peers.enumerate() {
match self.peers.filter_transaction(peer_index, &transaction, Some(fee_rate)) {
TransactionAnnouncementType::SendInventory => self.execute_inventory(peer_index, types::Inv::with_inventory(vec![
InventoryVector::tx(transaction.hash.clone()),
])),
TransactionAnnouncementType::DoNotAnnounce => (),
}
}
}
}
impl TaskExecutor for LocalSynchronizationTaskExecutor {
fn execute(&self, task: Task) {
match task {
Task::Ignore(peer_index, request_id) => self.execute_ignore(peer_index, request_id),
Task::GetData(peer_index, getdata) => self.execute_getdata(peer_index, getdata),
Task::GetHeaders(peer_index, getheaders) => self.execute_getheaders(peer_index, getheaders),
Task::MemoryPool(peer_index) => self.execute_memorypool(peer_index),
Task::Block(peer_index, block) => self.execute_block(peer_index, block),
Task::MerkleBlock(peer_index, block) => self.execute_merkleblock(peer_index, block),
Task::CompactBlock(peer_index, block) => self.execute_compact_block(peer_index, block),
Task::WitnessBlock(peer_index, block) => self.execute_witness_block(peer_index, block),
Task::Transaction(peer_index, transaction) => self.execute_transaction(peer_index, transaction),
Task::WitnessTransaction(peer_index, transaction) => self.execute_witness_transaction(peer_index, transaction),
Task::BlockTxn(peer_index, blocktxn) => self.execute_block_txn(peer_index, blocktxn),
Task::NotFound(peer_index, notfound) => self.execute_notfound(peer_index, notfound),
Task::Inventory(peer_index, inventory) => self.execute_inventory(peer_index, inventory),
Task::Headers(peer_index, headers, request_id) => self.execute_headers(peer_index, headers, request_id),
Task::RelayNewBlock(block) => self.execute_relay_block(block),
Task::RelayNewTransaction(transaction, fee_rate) => self.execute_relay_transaction(transaction, fee_rate),
}
}
}
#[cfg(test)]
pub mod tests {
extern crate test_data;
use super::*;
use std::sync::Arc;
use std::time;
use parking_lot::{Mutex, Condvar};
use chain::Transaction;
use message::{Services, types};
use inbound_connection::tests::DummyOutboundSyncConnection;
use local_node::tests::{default_filterload, make_filteradd};
use synchronization_peers::{PeersImpl, PeersContainer, PeersFilters, PeersOptions, BlockAnnouncementType};
pub struct DummyTaskExecutor {
tasks: Mutex<Vec<Task>>,
waiter: Arc<Condvar>,
}
impl DummyTaskExecutor {
pub fn new() -> Arc<Self> {
Arc::new(DummyTaskExecutor {
tasks: Mutex::new(Vec::new()),
waiter: Arc::new(Condvar::new()),
})
}
pub fn wait_tasks_for(executor: Arc<Self>, timeout_ms: u64) -> Vec<Task> {
{
let mut tasks = executor.tasks.lock();
if tasks.is_empty() {
let waiter = executor.waiter.clone();
waiter.wait_for(&mut tasks, time::Duration::from_millis(timeout_ms)).timed_out();
}
}
executor.take_tasks()
}
pub fn wait_tasks(executor: Arc<Self>) -> Vec<Task> {
DummyTaskExecutor::wait_tasks_for(executor, 1000)
}
pub fn take_tasks(&self) -> Vec<Task> {
let mut tasks = self.tasks.lock();
let tasks = tasks.drain(..).collect();
tasks
}
}
impl TaskExecutor for DummyTaskExecutor {
fn execute(&self, task: Task) {
self.tasks.lock().push(task);
self.waiter.notify_one();
}
}
#[test]
fn relay_new_block_after_sendcmpct() {
let peers = Arc::new(PeersImpl::default());
let executor = LocalSynchronizationTaskExecutor::new(peers.clone());
let c1 = DummyOutboundSyncConnection::new();
peers.insert(1, Services::default(), c1.clone());
let c2 = DummyOutboundSyncConnection::new();
peers.insert(2, Services::default(), c2.clone());
peers.set_block_announcement_type(2, BlockAnnouncementType::SendCompactBlock);
executor.execute(Task::RelayNewBlock(test_data::genesis().into()));
assert_eq!(*c1.messages.lock().entry("inventory".to_owned()).or_insert(0), 1);
assert_eq!(*c2.messages.lock().entry("cmpctblock".to_owned()).or_insert(0), 1);
}
#[test]
fn relay_new_block_after_sendheaders() {
let peers = Arc::new(PeersImpl::default());
let executor = LocalSynchronizationTaskExecutor::new(peers.clone());
let c1 = DummyOutboundSyncConnection::new();
peers.insert(1, Services::default(), c1.clone());
let c2 = DummyOutboundSyncConnection::new();
peers.insert(2, Services::default(), c2.clone());
peers.set_block_announcement_type(2, BlockAnnouncementType::SendHeaders);
executor.execute(Task::RelayNewBlock(test_data::genesis().into()));
assert_eq!(*c1.messages.lock().entry("inventory".to_owned()).or_insert(0), 1);
assert_eq!(*c2.messages.lock().entry("headers".to_owned()).or_insert(0), 1);
}
#[test]
fn relay_new_transaction_with_bloom_filter() {
let peers = Arc::new(PeersImpl::default());
let executor = LocalSynchronizationTaskExecutor::new(peers.clone());
let tx1: Transaction = test_data::TransactionBuilder::with_output(10).into();
let tx2: Transaction = test_data::TransactionBuilder::with_output(20).into();
let tx3: Transaction = test_data::TransactionBuilder::with_output(30).into();
let tx1_hash = tx1.hash();
let tx2_hash = tx2.hash();
let tx3_hash = tx3.hash();
let c1 = DummyOutboundSyncConnection::new();
peers.insert(1, Services::default(), c1.clone());
peers.set_bloom_filter(1, default_filterload());
peers.update_bloom_filter(1, make_filteradd(&*tx1_hash));
let c2 = DummyOutboundSyncConnection::new();
peers.insert(2, Services::default(), c2.clone());
peers.set_bloom_filter(2, default_filterload());
peers.update_bloom_filter(2, make_filteradd(&*tx2_hash));
let c3 = DummyOutboundSyncConnection::new();
peers.insert(3, Services::default(), c3.clone());
peers.set_bloom_filter(3, default_filterload());
peers.update_bloom_filter(3, make_filteradd(&*tx1_hash));
peers.update_bloom_filter(3, make_filteradd(&*tx2_hash));
let c4 = DummyOutboundSyncConnection::new();
peers.insert(4, Services::default(), c4.clone());
let c5 = DummyOutboundSyncConnection::new();
peers.insert(5, Services::default(), c5.clone());
peers.set_bloom_filter(5, default_filterload());
peers.update_bloom_filter(5, make_filteradd(&*tx3_hash));
executor.execute(Task::RelayNewTransaction(tx1.into(), 0));
assert_eq!(*c1.messages.lock().entry("inventory".to_owned()).or_insert(0), 1);
assert_eq!(*c2.messages.lock().entry("inventory".to_owned()).or_insert(0), 0);
assert_eq!(*c3.messages.lock().entry("inventory".to_owned()).or_insert(0), 1);
assert_eq!(*c4.messages.lock().entry("inventory".to_owned()).or_insert(0), 1);
executor.execute(Task::RelayNewTransaction(tx2.into(), 0));
assert_eq!(*c1.messages.lock().entry("inventory".to_owned()).or_insert(0), 1);
assert_eq!(*c2.messages.lock().entry("inventory".to_owned()).or_insert(0), 1);
assert_eq!(*c3.messages.lock().entry("inventory".to_owned()).or_insert(0), 2);
assert_eq!(*c4.messages.lock().entry("inventory".to_owned()).or_insert(0), 2);
}
#[test]
fn relay_new_transaction_with_feefilter() {
let peers = Arc::new(PeersImpl::default());
let executor = LocalSynchronizationTaskExecutor::new(peers.clone());
let c2 = DummyOutboundSyncConnection::new();
peers.insert(2, Services::default(), c2.clone());
peers.set_fee_filter(2, types::FeeFilter::with_fee_rate(3000));
let c3 = DummyOutboundSyncConnection::new();
peers.insert(3, Services::default(), c3.clone());
peers.set_fee_filter(3, types::FeeFilter::with_fee_rate(4000));
let c4 = DummyOutboundSyncConnection::new();
peers.insert(4, Services::default(), c4.clone());
executor.execute(Task::RelayNewTransaction(test_data::genesis().transactions[0].clone().into(), 3500));
assert_eq!(*c2.messages.lock().entry("inventory".to_owned()).or_insert(0), 1);
assert_eq!(*c3.messages.lock().entry("inventory".to_owned()).or_insert(0), 0);
assert_eq!(*c4.messages.lock().entry("inventory".to_owned()).or_insert(0), 1);
}
}