Core/grin
0
0
Fork 0
mirror of https://github.com/mimblewimble/grin.git synced 2025-01-21 03:21:08 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

cleanup build warnings (#1773)

Browse source 
add docs/comments
This commit is contained in:
Antioch Peverell 2018-10-17 16:04:33 +01:00 committed by GitHub
parent 7754adb834
commit a1f74441b5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
core/src/core/hash.rs
View file

@ -53,6 +53,7 @@ impl fmt::Display for Hash {
} }
impl Hash { impl Hash {
/// Size of a hash in bytes.
pub const SIZE: usize = 32; pub const SIZE: usize = 32;
/// Builds a Hash from a byte vector. If the vector is too short, it will be /// Builds a Hash from a byte vector. If the vector is too short, it will be

4
core/src/core/pmmr/backend.rs
View file

@ -18,11 +18,15 @@ use core::hash::Hash;
use core::BlockHeader; use core::BlockHeader;
use ser::PMMRable; use ser::PMMRable;
/// Simple "hash only" backend (used for header MMR, headers stored in the db).
pub trait HashOnlyBackend { pub trait HashOnlyBackend {
/// Append a vec of hashes to the backend.
fn append(&mut self, data: Vec<Hash>) -> Result<(), String>; fn append(&mut self, data: Vec<Hash>) -> Result<(), String>;
/// Rewind the backend to the specified position.
fn rewind(&mut self, position: u64) -> Result<(), String>; fn rewind(&mut self, position: u64) -> Result<(), String>;
/// Get the hash at the specified position.
fn get_hash(&self, position: u64) -> Option<Hash>; fn get_hash(&self, position: u64) -> Option<Hash>;
} }

8
core/src/core/pmmr/db_pmmr.rs
View file

@ -58,14 +58,17 @@ where
} }
} }
/// Get the unpruned size of the MMR.
pub fn unpruned_size(&self) -> u64 { pub fn unpruned_size(&self) -> u64 {
self.last_pos self.last_pos
} }
/// Is the MMR empty?
pub fn is_empty(&self) -> bool { pub fn is_empty(&self) -> bool {
self.last_pos == 0 self.last_pos == 0
} }
/// Rewind the MMR to the specified position.
pub fn rewind(&mut self, position: u64) -> Result<(), String> { pub fn rewind(&mut self, position: u64) -> Result<(), String> {
// Identify which actual position we should rewind to as the provided // Identify which actual position we should rewind to as the provided
// position is a leaf. We traverse the MMR to include any parent(s) that // position is a leaf. We traverse the MMR to include any parent(s) that
@ -126,6 +129,7 @@ where
Ok(elmt_pos) Ok(elmt_pos)
} }
/// Return the vec of peak hashes for this MMR.
pub fn peaks(&self) -> Vec<Hash> { pub fn peaks(&self) -> Vec<Hash> {
let peaks_pos = peaks(self.last_pos); let peaks_pos = peaks(self.last_pos);
peaks_pos peaks_pos
@ -134,6 +138,7 @@ where
.collect() .collect()
} }
/// Return the overall root hash for this MMR.
pub fn root(&self) -> Hash { pub fn root(&self) -> Hash {
let mut res = None; let mut res = None;
for peak in self.peaks().iter().rev() { for peak in self.peaks().iter().rev() {
@ -145,6 +150,9 @@ where
res.expect("no root, invalid tree") res.expect("no root, invalid tree")
} }
/// Validate all the hashes in the MMR.
/// For every parent node we check hashes of the children produce the parent hash
/// by hashing them together.
pub fn validate(&self) -> Result<(), String> { pub fn validate(&self) -> Result<(), String> {
// iterate on all parent nodes // iterate on all parent nodes
for n in 1..(self.last_pos + 1) { for n in 1..(self.last_pos + 1) {