ark_ec/hashing/
mod.rs

1use crate::CurveGroup;
2use ark_std::string::*;
3use core::fmt;
4
5pub mod curve_maps;
6pub mod map_to_curve_hasher;
7
8/// Trait for hashing arbitrary data to a group element on an elliptic curve
9pub trait HashToCurve<T: CurveGroup>: Sized {
10    /// Create a new hash to curve instance, with a given domain.
11    fn new(domain: &[u8]) -> Result<Self, HashToCurveError>;
12
13    /// Produce a hash of the message, which also depends on the domain.
14    /// The output of the hash is a curve point in the prime order subgroup
15    /// of the given elliptic curve.
16    fn hash(&self, message: &[u8]) -> Result<T::Affine, HashToCurveError>;
17}
18
19/// This is an error that could occur during the hash to curve process
20#[derive(Clone, Debug)]
21pub enum HashToCurveError {
22    /// Curve choice is unsupported by the given HashToCurve method.
23    UnsupportedCurveError(String),
24
25    /// Error with map to curve
26    MapToCurveError(String),
27}
28
29impl ark_std::error::Error for HashToCurveError {}
30
31impl fmt::Display for HashToCurveError {
32    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
33        match self {
34            HashToCurveError::UnsupportedCurveError(s) => write!(f, "{}", s),
35            HashToCurveError::MapToCurveError(s) => write!(f, "{}", s),
36        }
37    }
38}
39
40#[cfg(test)]
41mod tests;
ark_ec/hashing/mod.rs

ark_ec/hashing/
mod.rs
