Struct akd::directory::Directory

pub struct Directory<S, V> { /* private fields */ }

The representation of a auditable key directory

Implementations

impl<S: Storage + Sync + Send, V: VRFKeyStorage> Directory<S, V>

pub async fn new<H: Hasher>(
    storage: &S,
    vrf: &V,
    read_only: bool
) -> Result<Self, AkdError>

Creates a new (stateless) instance of a auditable key directory. Takes as input a pointer to the storage being used for this instance. The state is stored in the storage.

pub async fn publish<H: Hasher>(
    &self,
    updates: Vec<(AkdLabel, AkdValue)>
) -> Result<EpochHash<H>, AkdError>

Updates the directory to include the updated key-value pairs.

pub async fn lookup<H: Hasher>(
    &self,
    uname: AkdLabel
) -> Result<LookupProof<H>, AkdError>

Provides proof for correctness of latest version

pub async fn batch_lookup<H: Hasher>(
    &self,
    unames: &[AkdLabel]
) -> Result<Vec<LookupProof<H>>, AkdError>

Allows efficient batch lookups by preloading necessary nodes for the lookups.

pub async fn key_history<H: Hasher>(
    &self,
    uname: &AkdLabel
) -> Result<HistoryProof<H>, AkdError>

Takes in the current state of the server and a label. If the label is present in the current state, this function returns all the values ever associated with it, and the epoch at which each value was first committed to the server state. It also returns the proof of the latest version being served at all times.

pub async fn limited_key_history<H: Hasher>(
    &self,
    top_n_updates: usize,
    uname: &AkdLabel
) -> Result<HistoryProof<H>, AkdError>

Takes in the current state of the server and a label along with a “top” number of key updates to generate a proof for.

If the label is present in the current state, this function returns all the values & proof of validity up to top_n_updates results.

pub async fn poll_for_azks_changes(
    &self,
    period: Duration,
    change_detected: Option<Sender<()>>
) -> Result<(), AkdError>

Poll for changes in the epoch number of the AZKS struct stored in the storage layer. If an epoch change is detected, the object cache (if present) is flushed immediately so that new objects are retrieved from the storage layer against the “latest” epoch. There is a “special” flow in the storage layer to do a storage-layer retrieval which ignores the cache

pub async fn audit<H: Hasher>(
    &self,
    audit_start_ep: u64,
    audit_end_ep: u64
) -> Result<AppendOnlyProof<H>, AkdError>

Returns an AppendOnlyProof for the leaves inserted into the underlying tree between the epochs audit_start_ep and audit_end_ep.

pub async fn retrieve_current_azks(&self) -> Result<Azks, AkdError>

Retrieves the current azks

pub async fn get_public_key(&self) -> Result<VRFPublicKey, AkdError>

HELPERS /// Use this function to retrieve the VRF public key for this AKD.

pub async fn get_root_hash_at_epoch<H: Hasher>(
    &self,
    current_azks: &Azks,
    epoch: u64
) -> Result<H::Digest, AkdError>

Gets the azks root hash at the provided epoch. Note that the root hash should exist at any epoch that the azks existed, so as long as epoch >= 0, we should be fine.

pub async fn get_root_hash<H: Hasher>(
    &self,
    current_azks: &Azks
) -> Result<H::Digest, AkdError>

Gets the azks root hash at the current epoch.

Trait Implementations

impl<S: Clone, V: Clone> Clone for Directory<S, V>

fn clone(&self) -> Directory<S, V>

Returns a copy of the value.

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

Performs copy-assignment from source.