Struct akd::directory::Directory

pub struct Directory<S: Database + Sync + Send, V> { /* private fields */ }

The representation of a auditable key directory

Implementations

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

pub async fn new(
    storage: &StorageManager<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(
    &self,
    updates: Vec<(AkdLabel, AkdValue)>
) -> Result<EpochHash, AkdError>

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

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

Provides proof for correctness of latest version

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

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

pub async fn key_history(
    &self,
    uname: &AkdLabel,
    params: HistoryParams
) -> Result<HistoryProof, 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 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

NOTE: Due to the use of std::thread::sleep(.) this will BLOCK the polling thread, and should be allocated it’s own thread since it won’t yield

pub async fn audit(
    &self,
    audit_start_ep: u64,
    audit_end_ep: u64
) -> Result<AppendOnlyProof, 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_safe(
    &self,
    current_azks: &Azks,
    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 async fn get_root_hash(
    &self,
    current_azks: &Azks
) -> Result<Digest, AkdError>

Gets the azks root hash at the current epoch.

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

pub async fn publish_malicious_update(
    &self,
    updates: Vec<(AkdLabel, AkdValue)>,
    corruption: PublishCorruption
) -> Result<EpochHash, AkdError>

Updates the directory to include the updated key-value pairs with possible issues.

Trait Implementations

impl<S: Database + Sync + Send, V: VRFKeyStorage> Clone for Directory<S, V>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.