Newer
Older
use std::sync::Arc;
use parking_lot::RwLock;
use db;
use primitives::hash::H256;
use best_block::BestBlock;
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
/// Thread-safe reference to `Chain`
pub type ChainRef = Arc<RwLock<Chain>>;
/// Index of 'verifying' queue
const VERIFYING_QUEUE: usize = 0;
/// Index of 'requested' queue
const REQUESTED_QUEUE: usize = 1;
/// Index of 'scheduled' queue
const SCHEDULED_QUEUE: usize = 2;
/// Number of hash queues
const NUMBER_OF_QUEUES: usize = 3;
/// Block synchronization state
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum BlockState {
/// Block is unknown
Unknown,
/// Scheduled for requesting
Scheduled,
/// Requested from peers
Requested,
/// Currently verifying
Verifying,
/// In storage
Stored,
}
/// Synchronization chain information
#[derive(Debug)]
pub struct Information {
/// Number of blocks currently scheduled for requesting
pub scheduled: u64,
/// Number of blocks currently requested from peers
pub requested: u64,
/// Number of blocks currently verifying
pub verifying: u64,
/// Number of blocks in the storage
pub stored: u64,
}
/// Blockchain from synchroniation point of view, consisting of:
/// 1) all blocks from the `storage` [oldest blocks]
/// 2) all blocks currently verifying by `verification_queue`
/// 3) all blocks currently requested from peers
/// 4) all blocks currently scheduled for requesting [newest blocks]
pub struct Chain {
/// Genesis block hash (stored for optimizations)
genesis_block_hash: H256,
/// Best storage block hash (stored for optimizations)
best_storage_block_hash: H256,
/// Local blocks storage
storage: Arc<db::Store>,
/// In-memory queue of blocks hashes
hash_chain: HashQueueChain,
}
impl BlockState {
pub fn from_queue_index(queue_index: usize) -> BlockState {
match queue_index {
SCHEDULED_QUEUE => BlockState::Scheduled,
REQUESTED_QUEUE => BlockState::Requested,
VERIFYING_QUEUE => BlockState::Verifying,
_ => panic!("Unsupported queue_index: {}", queue_index),
}
}
pub fn to_queue_index(&self) -> usize {
match self {
&BlockState::Scheduled => SCHEDULED_QUEUE,
&BlockState::Requested => REQUESTED_QUEUE,
&BlockState::Verifying => VERIFYING_QUEUE,
_ => panic!("Unsupported queue: {:?}", self),
}
}
}
impl Chain {
/// Create new `Chain` with given storage
pub fn new(storage: Arc<db::Store>) -> Self {
// we only work with storages with genesis block
let genesis_block_hash = storage.block_hash(0)
.expect("storage with genesis block is required");
let best_storage_block_number = storage.best_block_number()
.expect("non-empty storage is required");
let best_storage_block_hash = storage.block_hash(best_storage_block_number)
.expect("checked above");
Chain {
genesis_block_hash: genesis_block_hash,
best_storage_block_hash: best_storage_block_hash,
storage: storage,
hash_chain: HashQueueChain::with_number_of_queues(NUMBER_OF_QUEUES),
}
}
/// Get information on current blockchain state
pub fn information(&self) -> Information {
Information {
scheduled: self.hash_chain.len_of(SCHEDULED_QUEUE) as u64,
requested: self.hash_chain.len_of(REQUESTED_QUEUE) as u64,
verifying: self.hash_chain.len_of(VERIFYING_QUEUE) as u64,
stored: self.storage.best_block_number().map_or(0, |number| number as u64 + 1),
/// Get storage
pub fn storage(&self) -> Arc<db::Store> {
self.storage.clone()
}
/// Get number of blocks in given state
pub fn length_of_state(&self, state: BlockState) -> u64 {
self.hash_chain.len_of(state.to_queue_index()) as u64
}
/// Returns true if has blocks of given type
pub fn has_blocks_of_state(&self, state: BlockState) -> bool {
!self.hash_chain.is_empty_at(state.to_queue_index())
}
/// Get best block
pub fn best_block(&self) -> BestBlock {
let storage_best_block_number = self.storage.best_block_number().expect("storage with genesis block is required");
match self.hash_chain.back() {
Some(hash) => BestBlock {
height: storage_best_block_number as u64 + self.hash_chain.len() as u64,
hash: hash.clone(),
},
None => BestBlock {
hash: self.storage.block_hash(storage_best_block_number).expect("storage with genesis block is required"),
}
}
}
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
/// Get best block of given state
pub fn best_block_of_state(&self, state: BlockState) -> Option<BestBlock> {
match state {
BlockState::Scheduled => self.hash_chain.back_at(SCHEDULED_QUEUE)
.map(|hash| BestBlock {
hash: hash,
height: self.storage.best_block_number().expect("storage with genesis block is required") as u64 + 1
+ self.hash_chain.len_of(VERIFYING_QUEUE) as u64
+ self.hash_chain.len_of(REQUESTED_QUEUE) as u64
+ self.hash_chain.len_of(SCHEDULED_QUEUE) as u64
}),
BlockState::Requested => self.hash_chain.back_at(REQUESTED_QUEUE)
.map(|hash| BestBlock {
hash: hash,
height: self.storage.best_block_number().expect("storage with genesis block is required") as u64 + 1
+ self.hash_chain.len_of(VERIFYING_QUEUE) as u64
+ self.hash_chain.len_of(REQUESTED_QUEUE) as u64
}),
BlockState::Verifying => self.hash_chain.back_at(VERIFYING_QUEUE)
.map(|hash| BestBlock {
hash: hash,
height: self.storage.best_block_number().expect("storage with genesis block is required") as u64 + 1
+ self.hash_chain.len_of(VERIFYING_QUEUE) as u64
}),
BlockState::Stored => {
let storage_best_block_number = self.storage.best_block_number().expect("storage with genesis block is required");
Some(BestBlock {
height: storage_best_block_number as u64,
hash: self.storage.block_hash(storage_best_block_number).expect("storage with genesis block is required"),
})
},
_ => panic!("not supported"),
}
}
/// Check if block has given state
pub fn block_has_state(&self, hash: &H256, state: BlockState) -> bool {
match state {
BlockState::Scheduled => self.hash_chain.is_contained_in(SCHEDULED_QUEUE, hash),
BlockState::Requested => self.hash_chain.is_contained_in(REQUESTED_QUEUE, hash),
BlockState::Verifying => self.hash_chain.is_contained_in(VERIFYING_QUEUE, hash),
BlockState::Stored => self.storage.contains_block(db::BlockRef::Hash(hash.clone())),
BlockState::Unknown => self.block_state(hash) == BlockState::Unknown,
}
}
/// Get block state
pub fn block_state(&self, hash: &H256) -> BlockState {
match self.hash_chain.contains_in(hash) {
Some(queue_index) => BlockState::from_queue_index(queue_index),
None => if self.storage.contains_block(db::BlockRef::Hash(hash.clone())) {
BlockState::Stored
} else {
BlockState::Unknown
},
}
}
/// Prepare best block locator hashes
pub fn best_block_locator_hashes(&self) -> Vec<H256> {
let mut result: Vec<H256> = Vec::with_capacity(4);
if let Some(pre_best_block) = self.hash_chain.back_skip_n_at(SCHEDULED_QUEUE, 2) {
result.push(pre_best_block);
if let Some(pre_best_block) = self.hash_chain.back_skip_n_at(REQUESTED_QUEUE, 2) {
result.push(pre_best_block);
if let Some(pre_best_block) = self.hash_chain.back_skip_n_at(VERIFYING_QUEUE, 2) {
result.push(pre_best_block);
}
result.push(self.best_storage_block_hash.clone());
result
}
/// Prepare block locator hashes, as described in protocol documentation:
/// https://en.bitcoin.it/wiki/Protocol_documentation#getblocks
pub fn block_locator_hashes(&self) -> Vec<H256> {
let mut block_locator_hashes: Vec<H256> = Vec::new();
// calculate for hash_queue
let (local_index, step) = self.block_locator_hashes_for_queue(&mut block_locator_hashes);
// calculate for storage
let storage_best_block_number = self.storage.best_block_number().expect("storage with genesis block is required");
let storage_index = if (storage_best_block_number as u64) < local_index { 0 } else { (storage_best_block_number as u64) - local_index };
self.block_locator_hashes_for_storage(storage_index as u64, step, &mut block_locator_hashes);
block_locator_hashes
}
/// Schedule blocks for requesting
pub fn schedule_blocks_hashes(&mut self, hashes: Vec<H256>) {
self.hash_chain.push_back_n_at(SCHEDULED_QUEUE, hashes)
}
/// Moves n blocks from scheduled queue to requested queue
pub fn request_blocks_hashes(&mut self, n: u64) -> Vec<H256> {
let scheduled = self.hash_chain.pop_front_n_at(SCHEDULED_QUEUE, n as usize);
self.hash_chain.push_back_n_at(REQUESTED_QUEUE, scheduled.clone());
scheduled
}
/// Add block to verifying queue
pub fn verify_block_hash(&mut self, hash: H256) {
self.hash_chain.push_back_at(VERIFYING_QUEUE, hash);
}
/// Moves n blocks from requested queue to verifying queue
#[cfg(test)]
pub fn verify_blocks_hashes(&mut self, n: u64) -> Vec<H256> {
let requested = self.hash_chain.pop_front_n_at(REQUESTED_QUEUE, n as usize);
self.hash_chain.push_back_n_at(VERIFYING_QUEUE, requested.clone());
requested
}
/// Insert new best block to storage
pub fn insert_best_block(&mut self, block: Block) -> Result<(), db::Error> {
if block.block_header.previous_header_hash != self.best_storage_block_hash {
return Err(db::Error::DB("Trying to insert out-of-order block".into()));
// remember new best block hash
self.best_storage_block_hash = block.hash();
// insert to storage
self.storage.insert_block(&block)
}
/// Remove block by hash if it is currently in given state
pub fn remove_block_with_state(&mut self, hash: &H256, state: BlockState) -> HashPosition {
self.hash_chain.remove_at(state.to_queue_index(), hash)
}
/// Remove all blocks with given state
pub fn remove_blocks_with_state(&mut self, state: BlockState) {
self.hash_chain.remove_all_at(state.to_queue_index());
}
/// Calculate block locator hashes for hash queue
fn block_locator_hashes_for_queue(&self, hashes: &mut Vec<H256>) -> (u64, u64) {
let queue_len = self.hash_chain.len() as u64;
if queue_len == 0 {
let mut index = queue_len - 1;
let mut step = 1u64;
let block_hash = self.hash_chain[index as usize].clone();
hashes.push(block_hash);
if hashes.len() >= 10 {
step <<= 1;
}
if index < step {
return (step - index - 1, step);
}
}
/// Calculate block locator hashes for storage
fn block_locator_hashes_for_storage(&self, mut index: u64, mut step: u64, hashes: &mut Vec<H256>) {
loop {
.expect("private function; index calculated in `block_locator_hashes`; qed");
hashes.push(block_hash);
if hashes.len() >= 10 {
step <<= 1;
}
if index < step {
// always include genesis hash
if index != 0 {
hashes.push(self.genesis_block_hash.clone())
}
break;
}
index -= step;
}
}
}
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
impl fmt::Debug for Chain {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
try!(writeln!(f, "chain: ["));
let mut num = self.storage.best_block_number().unwrap() as usize;
try!(writeln!(f, "\tworse(stored): {} {:?}", 0, self.storage.block_hash(0)));
try!(writeln!(f, "\tbest(stored): {} {:?}", num, self.storage.block_hash(num as u32)));
let queues = vec![
("verifying", VERIFYING_QUEUE),
("requested", REQUESTED_QUEUE),
("scheduled", SCHEDULED_QUEUE),
];
for (state, queue) in queues {
let queue_len = self.hash_chain.len_of(queue);
if queue_len != 0 {
try!(writeln!(f, "\tworse({}): {} {:?}", state, num + 1, self.hash_chain.front_at(queue)));
num += 1 + queue_len;
if let Some(pre_best) = self.hash_chain.pre_back_at(queue) {
try!(writeln!(f, "\tpre-best({}): {} {:?}", state, num - 1, pre_best));
}
try!(writeln!(f, "\tbest({}): {} {:?}", state, num, self.hash_chain.back_at(queue)));
}
}
writeln!(f, "]")
}
}
use chain::{Block, RepresentH256};
use super::Chain;
#[test]
fn chain_block_locator_hashes() {
let mut chain = Chain::new(Arc::new(db::TestStorage::with_genesis_block()));
let genesis_hash = chain.best_block().hash;
assert_eq!(chain.block_locator_hashes(), vec![genesis_hash.clone()]);
let block1: Block = "010000006fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000982051fd1e4ba744bbbe680e1fee14677ba1a3c3540bf7b1cdb606e857233e0e61bc6649ffff001d01e362990101000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0704ffff001d0104ffffffff0100f2052a0100000043410496b538e853519c726a2c91e61ec11600ae1390813a627c66fb8be7947be63c52da7589379515d4e0a604f8141781e62294721166bf621e73a82cbf2342c858eeac00000000".into();
let block1_hash = block1.hash();
chain.insert_best_block(block1).expect("Error inserting new block");
assert_eq!(chain.block_locator_hashes(), vec![block1_hash.clone(), genesis_hash.clone()]);
let block2: Block = "010000004860eb18bf1b1620e37e9490fc8a427514416fd75159ab86688e9a8300000000d5fdcc541e25de1c7a5addedf24858b8bb665c9f36ef744ee42c316022c90f9bb0bc6649ffff001d08d2bd610101000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0704ffff001d010bffffffff0100f2052a010000004341047211a824f55b505228e4c3d5194c1fcfaa15a456abdf37f9b9d97a4040afc073dee6c89064984f03385237d92167c13e236446b417ab79a0fcae412ae3316b77ac00000000".into();
let block2_hash = block2.hash();
chain.insert_best_block(block2).expect("Error inserting new block");
assert_eq!(chain.block_locator_hashes(), vec![block2_hash.clone(), block1_hash.clone(), genesis_hash.clone()]);
chain.schedule_blocks_hashes(vec![
"0000000000000000000000000000000000000000000000000000000000000000".into(),
"0000000000000000000000000000000000000000000000000000000000000001".into(),
"0000000000000000000000000000000000000000000000000000000000000002".into(),
"0000000000000000000000000000000000000000000000000000000000000003".into(),
"0000000000000000000000000000000000000000000000000000000000000004".into(),
"0000000000000000000000000000000000000000000000000000000000000005".into(),
"0000000000000000000000000000000000000000000000000000000000000006".into(),
"0000000000000000000000000000000000000000000000000000000000000007".into(),
"0000000000000000000000000000000000000000000000000000000000000008".into(),
"0000000000000000000000000000000000000000000000000000000000000009".into(),
"0000000000000000000000000000000000000000000000000000000000000010".into(),
]);
chain.request_blocks_hashes(10);
chain.verify_blocks_hashes(10);
assert_eq!(chain.best_block_locator_hashes()[0], "0000000000000000000000000000000000000000000000000000000000000010".into());
assert_eq!(chain.block_locator_hashes(), vec![
"0000000000000000000000000000000000000000000000000000000000000010".into(),
"0000000000000000000000000000000000000000000000000000000000000009".into(),
"0000000000000000000000000000000000000000000000000000000000000008".into(),
"0000000000000000000000000000000000000000000000000000000000000007".into(),
"0000000000000000000000000000000000000000000000000000000000000006".into(),
"0000000000000000000000000000000000000000000000000000000000000005".into(),
"0000000000000000000000000000000000000000000000000000000000000004".into(),
"0000000000000000000000000000000000000000000000000000000000000003".into(),
"0000000000000000000000000000000000000000000000000000000000000002".into(),
"0000000000000000000000000000000000000000000000000000000000000001".into(),
block2_hash.clone(),
genesis_hash.clone(),
]);
chain.schedule_blocks_hashes(vec![
"0000000000000000000000000000000000000000000000000000000000000011".into(),
"0000000000000000000000000000000000000000000000000000000000000012".into(),
"0000000000000000000000000000000000000000000000000000000000000013".into(),
"0000000000000000000000000000000000000000000000000000000000000014".into(),
"0000000000000000000000000000000000000000000000000000000000000015".into(),
"0000000000000000000000000000000000000000000000000000000000000016".into(),
]);
chain.request_blocks_hashes(10);
assert_eq!(chain.best_block_locator_hashes()[0], "0000000000000000000000000000000000000000000000000000000000000016".into());
assert_eq!(chain.block_locator_hashes(), vec![
"0000000000000000000000000000000000000000000000000000000000000016".into(),
"0000000000000000000000000000000000000000000000000000000000000015".into(),
"0000000000000000000000000000000000000000000000000000000000000014".into(),
"0000000000000000000000000000000000000000000000000000000000000013".into(),
"0000000000000000000000000000000000000000000000000000000000000012".into(),
"0000000000000000000000000000000000000000000000000000000000000011".into(),
"0000000000000000000000000000000000000000000000000000000000000010".into(),
"0000000000000000000000000000000000000000000000000000000000000009".into(),
"0000000000000000000000000000000000000000000000000000000000000008".into(),
"0000000000000000000000000000000000000000000000000000000000000007".into(),
"0000000000000000000000000000000000000000000000000000000000000005".into(),
"0000000000000000000000000000000000000000000000000000000000000001".into(),
genesis_hash.clone(),
]);
chain.schedule_blocks_hashes(vec![
"0000000000000000000000000000000000000000000000000000000000000020".into(),
"0000000000000000000000000000000000000000000000000000000000000021".into(),
"0000000000000000000000000000000000000000000000000000000000000022".into(),
]);
assert_eq!(chain.best_block_locator_hashes()[0], "0000000000000000000000000000000000000000000000000000000000000022".into());
assert_eq!(chain.block_locator_hashes(), vec![
"0000000000000000000000000000000000000000000000000000000000000022".into(),
"0000000000000000000000000000000000000000000000000000000000000021".into(),
"0000000000000000000000000000000000000000000000000000000000000020".into(),
"0000000000000000000000000000000000000000000000000000000000000016".into(),
"0000000000000000000000000000000000000000000000000000000000000015".into(),
"0000000000000000000000000000000000000000000000000000000000000014".into(),
"0000000000000000000000000000000000000000000000000000000000000013".into(),
"0000000000000000000000000000000000000000000000000000000000000012".into(),
"0000000000000000000000000000000000000000000000000000000000000011".into(),
"0000000000000000000000000000000000000000000000000000000000000010".into(),
"0000000000000000000000000000000000000000000000000000000000000008".into(),
"0000000000000000000000000000000000000000000000000000000000000004".into(),
genesis_hash.clone(),
]);
}
}