sos-core 0.17.3

Core types for the Save Our Secrets SDK
Documentation 
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

//! Create and compare commits in an underlying merkle tree.
mod proof;
mod tree;

use rs_merkle::{algorithms::Sha256, Hasher};
use serde::{Deserialize, Serialize};

/// Type for an Sha256 commit tree hash.
pub type TreeHash = <Sha256 as Hasher>::Hash;

/// Commit hash of zeroes.
pub const ZERO: TreeHash = [0u8; 32];

pub use proof::{CommitHash, CommitProof, Comparison};
pub use tree::CommitTree;

/// Commit state combines the last commit hash with
/// a commit proof.
#[derive(Serialize, Deserialize, Default, Debug, Clone, Eq, PartialEq)]
pub struct CommitState(pub CommitHash, pub CommitProof);

/// Commit span represents a section of an event log.
///
/// There can be no before commit hash when applying the first
/// collection of events to an event log. If an empty collection
/// was passed the after commit hash will be `None`.
#[derive(Serialize, Deserialize, Default, Debug, Clone, Eq, PartialEq)]
pub struct CommitSpan {
    /// Commit hash before changes were applied.
    pub before: Option<CommitHash>,
    /// Commit hash after changes were applied.
    pub after: Option<CommitHash>,
}