Struct akd::append_only_zks::Azks

pub struct Azks {
    pub latest_epoch: u64,
    pub num_nodes: u64,
}

An append-only zero knowledge set, the data structure used to efficiently implement a auditable key directory.

Fields

latest_epoch: u64

The latest complete epoch

num_nodes: u64

The number of nodes is the total size of this tree

Implementations

impl Azks

pub async fn new<S: Database>(
    storage: &StorageManager<S>
) -> Result<Self, AkdError>

Creates a new azks

pub async fn batch_insert_nodes<S: Database + 'static>(
    &mut self,
    storage: &StorageManager<S>,
    nodes: Vec<AzksElement>,
    insert_mode: InsertMode
) -> Result<(), AkdError>

Insert a batch of new leaves.

pub async fn get_membership_proof<S: Database>(
    &self,
    storage: &StorageManager<S>,
    label: NodeLabel,
    _epoch: u64
) -> Result<MembershipProof, AkdError>

Returns the Merkle membership proof for the trie as it stood at epoch

pub async fn get_non_membership_proof<S: Database>(
    &self,
    storage: &StorageManager<S>,
    label: NodeLabel
) -> Result<NonMembershipProof, AkdError>

In a compressed trie, the proof consists of the longest prefix of the label that is included in the trie, as well as its children, to show that none of the children is equal to the given label.

pub async fn get_append_only_proof<S: Database + 'static>(
    &self,
    storage: &StorageManager<S>,
    start_epoch: u64,
    end_epoch: u64
) -> Result<AppendOnlyProof, AkdError>

An append-only proof for going from start_epoch to end_epoch consists of roots of subtrees the azks tree that remain unchanged from start_epoch to end_epoch and the leaves inserted into the tree after start_epoch and up until end_epoch. If there is no errors, this function returns an Ok result, containing the append-only proof and otherwise, it returns an AkdError.

RESTRICTIONS: Note that start_epoch and end_epoch are valid only when the following are true

• start_epoch <= end_epoch
• start_epoch and end_epoch are both existing epochs of this AZKS

pub async fn get_root_hash<S: Database>(
    &self,
    storage: &StorageManager<S>
) -> Result<Digest, AkdError>

Gets the root hash for this azks

pub async fn get_root_hash_safe<S: Database>(
    &self,
    storage: &StorageManager<S>,
    epoch: u64
) -> Result<Digest, AkdError>

Gets the root hash of the tree at the latest epoch if the passed epoch is equal to the latest epoch. Will return an error otherwise.

pub fn get_latest_epoch(&self) -> u64

Gets the latest epoch of this azks. If an update aka epoch transition is in progress, this should return the most recent completed epoch.

Trait Implementations

impl Clone for Azks

fn clone(&self) -> Azks

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Azks

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Azks

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Azks

fn cmp(&self, other: &Azks) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Azks> for Azks

fn eq(&self, other: &Azks) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Azks> for Azks

fn partial_cmp(&self, other: &Azks) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl SizeOf for Azks

fn size_of(&self) -> usize

Retrieve the in-memory size of a structure

impl Storable for Azks

type StorageKey = u8

This particular storage will have a key type

fn data_type() -> StorageType

Must return a valid storage type

fn get_id(&self) -> u8

Retrieve an instance of the id of this storable. The combination of the storable’s StorageType and this id are globally unique

fn get_full_binary_key_id(key: &u8) -> Vec<u8>

Retrieve the full binary version of a key (for comparisons)

fn key_from_full_binary(bin: &[u8]) -> Result<u8, String>

Reformat a key from the full-binary specification

fn get_full_binary_id(&self) -> Vec<u8>

Retrieve the full binary version of a key (for comparisons)

impl Eq for Azks

impl StructuralEq for Azks

impl StructuralPartialEq for Azks

impl Sync for Azks