1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

// Copyright (C) 2019-2022 Aleo Systems Inc.
// This file is part of the snarkVM library.

// The snarkVM library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// The snarkVM library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with the snarkVM library. If not, see <https://www.gnu.org/licenses/>.

use snarkvm_circuit_types::{
    environment::{Eject, Inject, ScalarTrait, Ternary, ToBits},
    GroupTrait,
};

/// A trait for a commitment scheme.
pub trait Commit {
    type Input;
    type Output;
    type Randomizer;

    /// Returns the commitment to the given input and randomizer.
    fn commit(&self, input: &[Self::Input], randomizer: &Self::Randomizer) -> Self::Output;
}

/// A trait for a commitment scheme.
pub trait CommitUncompressed {
    type Input;
    type Output;
    type Randomizer;

    /// Returns the commitment to the given input and randomizer.
    fn commit_uncompressed(&self, input: &[Self::Input], randomizer: &Self::Randomizer) -> Self::Output;
}

/// A trait for a hash function.
pub trait Hash {
    type Input: Inject + Eject + Clone;
    type Output: Inject + Eject + Ternary<Output = Self::Output> + ToBits + Clone;

    /// Returns the hash of the given input.
    fn hash(&self, input: &[Self::Input]) -> Self::Output;
}

/// A trait for a hash function that produces multiple outputs.
pub trait HashMany {
    type Input;
    type Output;

    /// Returns the hash of the given input.
    fn hash_many(&self, input: &[Self::Input], num_outputs: u16) -> Vec<Self::Output>;
}

/// A trait for a hash function that projects the value to an affine group element.
pub trait HashToGroup {
    type Input;
    type Group: GroupTrait<Self::Scalar>;
    type Scalar: ScalarTrait;

    /// Returns the hash of the given input.
    fn hash_to_group(&self, input: &[Self::Input]) -> Self::Group;
}

/// A trait for a hash function that projects the value to a scalar.
pub trait HashToScalar {
    type Input;
    type Scalar: ScalarTrait;

    /// Returns the hash of the given input.
    fn hash_to_scalar(&self, input: &[Self::Input]) -> Self::Scalar;
}

/// A trait for a hash function of an uncompressed variant.
pub trait HashUncompressed {
    type Input;
    type Output;

    /// Returns the hash of the given input.
    fn hash_uncompressed(&self, input: &[Self::Input]) -> Self::Output;
}

/// A trait for a pseudorandom function.
pub trait PRF {
    type Seed;
    type Input;
    type Output;

    /// Returns the output for the given seed and input.
    fn prf(&self, seed: &Self::Seed, input: &[Self::Input]) -> Self::Output;
}