Add further FROST documentation

This commit is contained in:
Luke Parker
2022-09-29 06:02:43 -04:00
parent 8d9315b797
commit 7870084b9e
7 changed files with 69 additions and 23 deletions

View File

@@ -9,6 +9,8 @@ use crate::{curve::Curve, algorithm::Hram};
macro_rules! dalek_curve {
(
$feature: literal,
$Curve: ident,
$Hram: ident,
$Point: ident,
@@ -19,6 +21,7 @@ macro_rules! dalek_curve {
) => {
use dalek_ff_group::$Point;
#[cfg_attr(docsrs, doc(cfg(feature = $feature)))]
#[derive(Clone, Copy, PartialEq, Eq, Debug, Zeroize)]
pub struct $Curve;
impl $Curve {
@@ -46,6 +49,7 @@ macro_rules! dalek_curve {
}
}
#[cfg_attr(docsrs, doc(cfg(feature = $feature)))]
#[derive(Copy, Clone)]
pub struct $Hram;
impl Hram<$Curve> for $Hram {
@@ -65,6 +69,7 @@ macro_rules! dalek_curve {
#[cfg(any(test, feature = "ristretto"))]
dalek_curve!(
"ristretto",
Ristretto,
IetfRistrettoHram,
RistrettoPoint,
@@ -75,6 +80,7 @@ dalek_curve!(
#[cfg(feature = "ed25519")]
dalek_curve!(
"ed25519",
Ed25519,
IetfEd25519Hram,
EdwardsPoint,