Struct akd::append_only_zks::Azks

source · [−]

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

Expand description

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 ie the size of this tree

Implementations

source

impl Azks

source

pub async fn new<S: Storage + Sync + Send, H: Hasher>(
storage: &S
) -> Result<Self, AkdError>

Creates a new azks

source

pub async fn batch_insert_leaves<S: Storage + Sync + Send, H: Hasher>(
 &mut self,
 storage: &S,
 insertion_set: Vec<Node<H>>
) -> Result<(), AkdError>

Insert a batch of new leaves

source

pub async fn bfs_preload_nodes<S: Storage + Sync + Send, H: Hasher>(
 &self,
 storage: &S,
 nodes_to_load: HashSet<NodeLabel>
) -> Result<u64, AkdError>

Preloads given nodes using breadth-first search.

source

pub async fn batch_insert_leaves_helper<S: Storage + Sync + Send, H: Hasher>(
 &mut self,
 storage: &S,
 insertion_set: Vec<Node<H>>,
 append_only_exclude_usage: bool
) -> Result<(), AkdError>

An azks is built both by the crate::directory::Directory and the auditor. However, both constructions have very minor differences, and the append_only_usage bool keeps track of this.

source

pub async fn get_membership_proof<S: Storage + Sync + Send, H: Hasher>(
 &self,
 storage: &S,
 label: NodeLabel,
 _epoch: u64
) -> Result<MembershipProof<H>, AkdError>

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

source

pub async fn get_non_membership_proof<S: Storage + Sync + Send, H: Hasher>(
 &self,
 storage: &S,
 label: NodeLabel
) -> Result<NonMembershipProof<H>, 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.

source

pub async fn get_append_only_proof<S: Storage + Sync + Send, H: Hasher>(
 &self,
 storage: &S,
 start_epoch: u64,
 end_epoch: u64
) -> Result<AppendOnlyProof<H>, 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 a errors::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

source

pub async fn get_root_hash<S: Storage + Sync + Send, H: Hasher>(
&self,
storage: &S
) -> Result<H::Digest, AkdError>

Gets the root hash for this azks

source

pub async fn get_root_hash_at_epoch<S: Storage + Sync + Send, H: Hasher>(
 &self,
 storage: &S,
 epoch: u64
) -> Result<H::Digest, AkdError>

Gets the root hash of the tree at a epoch. Since this is accessing the root node and the root node exists at all epochs that the azks does, this would never be called at an epoch before the birth of the root node.

source

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.

source

pub async fn get_membership_proof_and_node<S: Storage + Sync + Send, H: Hasher>(
 &self,
 storage: &S,
 label: NodeLabel
) -> Result<(MembershipProof<H>, NodeLabel), AkdError>

This function returns the node label for the node whose label is the longest common prefix for the queried label. It also returns a membership proof for said label. This is meant to be used in both, getting membership proofs and getting non-membership proofs.