hotshot_types/
vid.rs

1// Copyright (c) 2021-2024 Espresso Systems (espressosys.com)
2// This file is part of the HotShot repository.
3
4// You should have received a copy of the MIT License
5// along with the HotShot repository. If not, see <https://mit-license.org/>.
6
7//! This module provides:
8//! - an opaque constructor [`vid_scheme`] that returns a new instance of a
9//!   VID scheme.
10//! - type aliases [`VidCommitment`], [`VidCommon`], [`VidShare`]
11//!   for [`VidScheme`] assoc types.
12//!
13//! Purpose: the specific choice of VID scheme is an implementation detail.
14//! This crate and all downstream crates should talk to the VID scheme only
15//! via the traits exposed here.
16
17#![allow(missing_docs)]
18
19pub mod advz;
20pub mod avidm;