mirror/lighthouse-pulse
1
0
Fork 0
mirror of https://gitlab.com/pulsechaincom/lighthouse-pulse.git synced 2024-12-28 14:57:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Tidy BlockGraph, use parking_lot, add doc comments

Browse Source
This commit is contained in:
Paul Hauner 2019-02-01 15:59:12 +11:00
parent d4757f2e09
commit 1e6f85a5eb
No known key found for this signature in database
GPG Key ID: D362883A9218FCC6
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
beacon_node/beacon_chain/src/block_graph.rs
View File

@ -1,12 +1,22 @@
use parking_lot::{RwLock, RwLockReadGuard};
use std::collections::HashSet;
use std::sync::{RwLock, RwLockReadGuard};
use types::Hash256;
/// Maintains a view of the block DAG, also known as the "blockchain" (except, it tracks multiple
/// chains eminating from a single root instead of just the head of some canonical chain).
///
/// The BlockGraph does not store the blocks, instead it tracks the block hashes of blocks at the
/// tip of the DAG. It is out of the scope of the object to retrieve blocks.
///
/// Presently, the DAG root (genesis block) is not tracked.
///
/// The BlogGraph is thread-safe due to internal RwLocks.
pub struct BlockGraph {
pub leaves: RwLock<HashSet<Hash256>>,
}
impl BlockGraph {
/// Create a new block graph without any leaves.
pub fn new() -> Self {
Self {
leaves: RwLock::new(HashSet::new()),
@ -15,10 +25,7 @@ impl BlockGraph {
/// Add a new leaf to the block hash graph. Returns `true` if the leaf was built upon another
/// leaf.
pub fn add_leaf(&self, parent: &Hash256, leaf: Hash256) -> bool {
let mut leaves = self
.leaves
.write()
.expect("CRITICAL: BlockGraph poisioned.");
let mut leaves = self.leaves.write();
if leaves.contains(parent) {
leaves.remove(parent);
@ -30,7 +37,8 @@ impl BlockGraph {
}
}
/// Returns a read-guarded HashSet of all leaf blocks.
pub fn leaves(&self) -> RwLockReadGuard<HashSet<Hash256>> {
self.leaves.read().expect("CRITICAL: BlockGraph poisioned.")
self.leaves.read()
}
}