zec
/
orchard
mirror of https://github.com/zcash/orchard.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add documentation 

Co-authored-by: str4d <jack@electriccoin.co>
This commit is contained in:
ying tong 2021-03-18 11:41:42 +08:00 committed by therealyingtong
parent a3134e34c5
commit 946b50ebfe
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/primitives/sinsemilla.rs
View File

@ -76,11 +76,21 @@ impl<I: Iterator<Item = bool>> Iterator for Pad<I> {
}
}
/// Trait representing a domain in which [`sinsemilla::hash_to_point`] and
/// [`sinsemilla::hash`] can be used.
///
/// [`sinsemilla::hash_to_point`]: self::hash_to_point
/// [`sinsemilla::hash`]: self::hash
pub trait HashDomain {
#[allow(non_snake_case)]
fn Q(&self) -> pallas::Point;
}
/// A domain with a specific prefix string, in which [`sinsemilla::hash_to_point`] and
/// [`sinsemilla::hash`] can be used.
///
/// [`sinsemilla::hash_to_point`]: self::hash_to_point
/// [`sinsemilla::hash`]: self::hash
pub struct Domain(pub &'static str);
impl HashDomain for Domain {
@ -114,11 +124,21 @@ pub(crate) fn hash<D: HashDomain>(domain: &D, msg: impl Iterator<Item = bool>) -
extract_p(&hash_to_point(domain, msg))
}
/// Trait representing a domain in which [`sinsemilla::commit`] and
/// [`sinsemilla::short_commit`] can be used.
///
/// [`sinsemilla::commit`]: self::commit
/// [`sinsemilla::short_commit`]: self::short_commit
pub trait CommitDomain: HashDomain {
#[allow(non_snake_case)]
fn R(&self) -> pallas::Point;
}
/// A domain with a specific prefix string, in which [`sinsemilla::commit`] and
/// [`sinsemilla::short_commit`] can be used.
///
/// [`sinsemilla::commit`]: self::commit
/// [`sinsemilla::short_commit`]: self::short_commit
pub struct Comm(pub &'static str);
impl HashDomain for Comm {