-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathpeer.rs
More file actions
387 lines (355 loc) · 13.6 KB
/
Copy pathpeer.rs
File metadata and controls
387 lines (355 loc) · 13.6 KB
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
use std::{
collections::{HashMap, HashSet},
fmt,
net::SocketAddr,
sync::{mpsc, Arc, Mutex},
};
use bitcoin::{
hashes::Hash,
p2p::{
address::AddrV2Message,
message::NetworkMessage,
message_blockdata::{GetBlocksMessage, GetHeadersMessage, Inventory},
Address, ServiceFlags,
},
};
use bitcoin::{BlockHash, Network};
use bitcoinkernel::{
core::BlockHashExt, prelude::BlockValidationStateExt, BlockTreeEntry, ChainstateManager,
Context, ProcessBlockHeaderResult, ValidationMode,
};
use log::{debug, info, warn};
use p2p::{
handshake::{ConnectionConfig, ProtocolVersion},
net::{ConnectionExt, ConnectionReader, ConnectionWriter, TimeoutParams},
};
use crate::{
ext::{CrateBlockExt, CrateHeaderExt},
logging::Category,
};
const PROTOCOL_VERSION: ProtocolVersion = 70015;
const MAX_LOCATOR_HASHES: usize = 101;
#[derive(Clone)]
pub struct TipState {
pub block_hash: bitcoin::BlockHash,
}
impl Default for TipState {
fn default() -> Self {
Self {
block_hash: BlockHash::all_zeros(),
}
}
}
pub struct NodeState {
pub addr_tx: mpsc::Sender<Vec<AddrV2Message>>,
pub block_tx: mpsc::SyncSender<bitcoinkernel::Block>,
pub tip_state: Arc<Mutex<TipState>>,
pub context: Arc<Context>,
pub chainman: Arc<ChainstateManager>,
}
impl NodeState {
pub fn set_tip_state(&self, block_hash: bitcoin::BlockHash) {
let mut state = self.tip_state.lock().unwrap();
state.block_hash = block_hash;
}
pub fn get_tip_state(&self) -> TipState {
let state = self.tip_state.lock().unwrap();
state.clone()
}
}
/// State Machine for setting up a connection and getting blocks from a peer
///
/// ```text
/// [*]
/// │
/// AwaitingHeaders ◄──┐
/// │ │
/// ▼ │ unconnecting headers
/// AwaitingInv ─────┘
/// ▲ |
/// Block | | Inv / Headers
/// | ▼
/// AwaitingBlock
/// │ ▲
/// │ │
/// └─┘
/// Block
/// ```
#[derive(Default)]
pub enum PeerStateMachine {
#[default]
AwaitingHeaders,
AwaitingInv,
AwaitingBlock(AwaitingBlock),
}
pub struct AwaitingBlock {
pub peer_inventory: HashSet<bitcoin::BlockHash>,
pub block_buffer: HashMap<bitcoin::BlockHash /*prev */, bitcoinkernel::Block>,
}
fn build_block_locators(tip: BlockTreeEntry<'_>) -> Vec<BlockHash> {
let height = tip.height();
assert!(height >= 0);
let mut locators = Vec::with_capacity(MAX_LOCATOR_HASHES);
let mut entry = tip;
let mut current_height = height as usize;
let mut step: usize = 1;
loop {
let hash = BlockHash::from_byte_array(entry.block_hash().to_bytes());
locators.push(hash);
if current_height == 0 || locators.len() >= MAX_LOCATOR_HASHES {
break;
}
if locators.len() > 10 {
step *= 2;
}
let target = current_height.saturating_sub(step);
while current_height > target {
match entry.prev() {
Some(prev) => {
entry = prev;
current_height -= 1;
}
None => break,
}
}
}
locators
}
fn create_getheaders_message(locator_hashes: Vec<bitcoin::BlockHash>) -> NetworkMessage {
NetworkMessage::GetHeaders(GetHeadersMessage {
version: PROTOCOL_VERSION,
locator_hashes,
stop_hash: bitcoin::BlockHash::all_zeros(),
})
}
fn create_getblocks_message(locator_hashes: Vec<bitcoin::BlockHash>) -> NetworkMessage {
NetworkMessage::GetBlocks(GetBlocksMessage {
version: PROTOCOL_VERSION,
locator_hashes,
stop_hash: bitcoin::BlockHash::all_zeros(),
})
}
fn create_getdata_message(block_hashes: &[bitcoin::BlockHash]) -> NetworkMessage {
let inventory: Vec<Inventory> = block_hashes
.iter()
.map(|hash| Inventory::WitnessBlock(*hash))
.collect();
NetworkMessage::GetData(inventory)
}
pub fn process_message(
state_machine: PeerStateMachine,
event: NetworkMessage,
node_state: &mut NodeState,
) -> (PeerStateMachine, Vec<NetworkMessage>) {
// Always process the ping first as a special case.
if let NetworkMessage::Ping(nonce) = event {
info!(target: Category::NET, "Received ping, responding pong.");
return (state_machine, vec![NetworkMessage::Pong(nonce)]);
}
if let NetworkMessage::AddrV2(payload) = event {
info!(target: Category::NET, "Received {} net addresses", payload.len());
// If the address manager has a full queue these net addresses should be dropped.
let _ = node_state.addr_tx.send(payload);
return (state_machine, vec![]);
}
match state_machine {
PeerStateMachine::AwaitingHeaders => match event {
NetworkMessage::Headers(headers) => {
let msg_len = headers.len();
for header in headers.into_iter() {
let result = node_state.chainman.process_block_header(&header.convert());
match result {
ProcessBlockHeaderResult::Success(state)
if state.mode() == ValidationMode::Valid =>
{
debug!(target: Category::KERNEL, "Processed header: {}", header.time);
continue;
}
_ => {
warn!(target: Category::KERNEL, "Rejected header {}", header.block_hash());
break;
}
}
}
if msg_len != 2000 {
let locators = build_block_locators(node_state.chainman.active_chain().tip());
return (
PeerStateMachine::AwaitingInv,
vec![create_getblocks_message(locators)],
);
}
let locators = build_block_locators(node_state.chainman.best_entry().unwrap());
(
PeerStateMachine::AwaitingHeaders,
vec![create_getheaders_message(locators)],
)
}
message => {
debug!(target: Category::NET, "Ignoring message: {:?}", message);
(PeerStateMachine::AwaitingHeaders, vec![])
}
},
PeerStateMachine::AwaitingInv => match event {
NetworkMessage::Headers(headers) => {
let mut announced = Vec::with_capacity(headers.len());
for header in headers {
let block_hash = header.block_hash();
let valid = matches!(
node_state.chainman.process_block_header(&header.convert()),
ProcessBlockHeaderResult::Success(s) if s.mode() == ValidationMode::Valid
);
if !valid {
warn!(target: Category::KERNEL, "Rejected announced header {}", block_hash);
break;
}
announced.push(block_hash);
}
if announced.is_empty() {
let locators = build_block_locators(node_state.chainman.best_entry().unwrap());
return (
PeerStateMachine::AwaitingHeaders,
vec![create_getheaders_message(locators)],
);
}
debug!(target: Category::NET, "Requesting {} announced blocks", announced.len());
(
PeerStateMachine::AwaitingBlock(AwaitingBlock {
peer_inventory: announced.iter().copied().collect(),
block_buffer: HashMap::new(),
}),
vec![create_getdata_message(&announced)],
)
}
NetworkMessage::Inv(inventory) => {
debug!(target: Category::NET, "Received inventory with {} items", inventory.len());
let block_hashes: Vec<bitcoin::BlockHash> = inventory
.iter()
.filter_map(|inv| match inv {
Inventory::Block(hash) => Some(*hash),
_ => None,
})
.collect();
if !block_hashes.is_empty() {
debug!(target: Category::NET, "Requesting {} blocks", block_hashes.len());
(
PeerStateMachine::AwaitingBlock(AwaitingBlock {
peer_inventory: block_hashes.iter().cloned().collect(),
block_buffer: HashMap::new(),
}),
vec![create_getdata_message(&block_hashes)],
)
} else {
(PeerStateMachine::AwaitingInv, vec![])
}
}
message => {
debug!(target: Category::NET, "Ignoring message: {:?}", message);
(PeerStateMachine::AwaitingInv, vec![])
}
},
PeerStateMachine::AwaitingBlock(mut block_state) => match event {
NetworkMessage::Block(block) => {
let prev_blockhash = block.header.prev_blockhash;
block_state.peer_inventory.remove(&block.block_hash());
block_state
.block_buffer
.insert(prev_blockhash, block.convert());
while let Some(next_block) = block_state
.block_buffer
.remove(&node_state.get_tip_state().block_hash)
{
if let Err(err) = node_state.block_tx.send(next_block) {
debug!(target: Category::NODE, "Encountered error on block send: {}", err);
return (PeerStateMachine::AwaitingBlock(block_state), vec![]);
}
}
// All expected blocks have arrived. Flush anything left in the
// buffer to the kernel and request the next batch. The leftovers
// are a competing branch from a reorg.
if block_state.peer_inventory.is_empty() {
let leftovers: Vec<_> =
block_state.block_buffer.drain().map(|(_, b)| b).collect();
for leftover in leftovers {
if let Err(err) = node_state.block_tx.send(leftover) {
debug!(target: Category::NODE, "Encountered error on block send: {}", err);
return (PeerStateMachine::AwaitingBlock(block_state), vec![]);
}
}
let locators = build_block_locators(node_state.chainman.active_chain().tip());
(
PeerStateMachine::AwaitingInv,
vec![create_getblocks_message(locators)],
)
} else {
(PeerStateMachine::AwaitingBlock(block_state), vec![])
}
}
message => {
debug!(target: Category::NET, "Ignoring message: {:?}", message);
(PeerStateMachine::AwaitingBlock(block_state), vec![])
}
},
}
}
pub struct BitcoinPeer {
addr: Address,
writer: Arc<ConnectionWriter>,
reader: ConnectionReader,
state_machine: PeerStateMachine,
}
impl fmt::Display for BitcoinPeer {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{:?}", self.addr)
}
}
impl BitcoinPeer {
pub fn new(
socket_addr: SocketAddr,
network: Network,
node_state: &mut NodeState,
) -> Result<Self, p2p::net::Error> {
let height = node_state.chainman.active_chain().height();
let conf = ConnectionConfig::new()
.change_network(network)
.our_height(height)
.request_addr()
.set_service_requirement(ServiceFlags::NETWORK)
.offer_services(ServiceFlags::WITNESS)
.user_agent("/kernel-node:0.1.0/".into());
let (writer, reader, _) = conf.open_connection(socket_addr, TimeoutParams::new())?;
let addr = Address::new(&socket_addr, ServiceFlags::WITNESS);
info!(target: Category::NET, "Connected to {:?}", addr);
let locators = build_block_locators(node_state.chainman.best_entry().unwrap());
debug!(target: Category::NET, "Sending headers message...");
writer.send_message(create_getheaders_message(locators))?;
let peer = BitcoinPeer {
addr,
writer: Arc::new(writer),
reader,
state_machine: PeerStateMachine::AwaitingHeaders,
};
Ok(peer)
}
pub fn writer(&self) -> Arc<ConnectionWriter> {
Arc::clone(&self.writer)
}
fn receive_message(&mut self) -> Result<NetworkMessage, p2p::net::Error> {
Ok(self
.reader
.read_message()?
.expect("v1 only supported currently"))
}
pub fn receive_and_process_message(
&mut self,
node_state: &mut NodeState,
) -> Result<(), p2p::net::Error> {
let msg = self.receive_message()?;
let old_state = std::mem::take(&mut self.state_machine);
let (peer_state_machine, mut messages) = process_message(old_state, msg, node_state);
self.state_machine = peer_state_machine;
for message in messages.drain(..) {
self.writer.send_message(message)?
}
Ok(())
}
}