Struct sos_sdk::commit::CommitTree

pub struct CommitTree { /* private fields */ }

Encapsulates a Merkle tree and provides functions for generating and comparing proofs.

Implementations

impl CommitTree

pub fn new() -> Self

Create a new empty commit tree.

pub fn hash(data: &[u8]) -> TreeHash

Compute the Sha256 hash of some data.

pub fn len(&self) -> usize

Number of leaves in the tree.

pub fn is_empty(&self) -> bool

Determine if this commit tree is empty.

pub fn insert(&mut self, hash: TreeHash) -> &mut Self

Insert a commit hash into the tree,

pub fn append(&mut self, hashes: &mut Vec<TreeHash>) -> &mut Self

Append a collections of commit hashes to the tree.

pub fn commit(&mut self)

Commit changes to the tree to compute the root.

pub fn rollback(&mut self)

Revert changes to the tree.

pub fn leaves(&self) -> Option<Vec<TreeHash>>

Leaves of the tree.

pub fn head(&self) -> Result<CommitProof>

Root hash and a proof of the last leaf node.

pub fn proof(&self, leaf_indices: &[usize]) -> Result<CommitProof>

Proof for the given indices.

pub fn compare(&self, proof: &CommitProof) -> Result<Comparison>

Compare this tree against another root hash and merkle proof.

pub fn first_commit(&self) -> Result<CommitState>

Compute the first commit state.

Must have at least one commit.

pub fn last_commit(&self) -> Option<CommitHash>

Last commit hash in the underlying merkle tree.

pub fn commit_state(&self) -> Result<CommitState>

Commit state of this tree.

The tree must already have some commits.

pub fn root(&self) -> Option<CommitHash>

Root hash of the underlying merkle tree.

pub fn root_hex(&self) -> Option<String>

Root hash of the underlying merkle tree as hexadecimal.

pub fn contains(&self, other_proof: &CommitProof) -> Result<Option<CommitProof>>

Given a proof from another tree determine if this tree contains the other proof.

Trait Implementations

impl Default for CommitTree

fn default() -> CommitTree

Returns the “default value” for a type.

impl From<&Vault> for CommitTree

Available on debug-assertions enabled only.

fn from(value: &Vault) -> Self

Converts to this type from the input type.