snarkvm-console-network-environment 4.6.1

Environment console library for a decentralized virtual machine
Documentation 
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

// Copyright (c) 2019-2026 Provable Inc.
// This file is part of the snarkVM library.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:

// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use anyhow::Result;

/// 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) -> Result<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) -> Result<Self::Output>;
}

/// A trait for a hash function.
pub trait Hash {
    type Input;
    type Output;

    /// Returns the hash of the given input.
    fn hash(&self, input: &[Self::Input]) -> Result<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 Output;

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

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

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

/// 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]) -> Result<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]) -> Result<Self::Output>;
}