forked from qdrvm/kagome
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vrf_provider.hpp
76 lines (65 loc) · 2.31 KB
/
vrf_provider.hpp
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
/**
* Copyright Quadrivium LLC
* All Rights Reserved
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <optional>
#include "common/buffer.hpp"
#include "crypto/sr25519_types.hpp"
#include "primitives/transcript.hpp"
namespace kagome::crypto {
/**
* SR25519 based verifiable random function implementation
*/
class VRFProvider {
public:
virtual ~VRFProvider() = default;
/**
* Generates random keypair for signing the message
*/
virtual Sr25519Keypair generateKeypair() const = 0;
/**
* Sign message \param msg using \param keypair. If computed value is less
* than \param threshold then return optional containing this value and
* proof. Otherwise none returned
*/
virtual std::optional<VRFOutput> sign(
const common::Buffer &msg,
const Sr25519Keypair &keypair,
const VRFThreshold &threshold) const = 0;
/**
* Verifies that \param output was derived using \param public_key on \param
* msg
*/
virtual VRFVerifyOutput verify(const common::Buffer &msg,
const VRFOutput &output,
const Sr25519PublicKey &public_key,
const VRFThreshold &threshold) const = 0;
/**
* Sign transcript message \param msg using \param keypair. If computed
* value is less than \param threshold then return optional containing this
* value and proof. Otherwise none returned
*/
virtual std::optional<VRFOutput> signTranscript(
const primitives::Transcript &msg,
const Sr25519Keypair &keypair,
const VRFThreshold &threshold) const = 0;
/**
* Sign transcript message \param msg using \param keypair without any
* threshold check. Returns proof if no error happened.
*/
virtual std::optional<VRFOutput> signTranscript(
const primitives::Transcript &msg,
const Sr25519Keypair &keypair) const = 0;
/**
* Verifies that \param output was derived using \param public_key on
* transcript \param msg
*/
virtual VRFVerifyOutput verifyTranscript(
const primitives::Transcript &msg,
const VRFOutput &output,
const Sr25519PublicKey &public_key,
const VRFThreshold &threshold) const = 0;
};
} // namespace kagome::crypto