snarkvm_ledger_authority/
lib.rs

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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
// Copyright 2024 Aleo Network Foundation
// 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.

#![forbid(unsafe_code)]
#![warn(clippy::cast_possible_truncation)]

mod bytes;
mod serialize;
mod string;

use console::{
    account::{Address, PrivateKey, Signature},
    network::Network,
    prelude::{
        Debug,
        Deserialize,
        DeserializeExt,
        Deserializer,
        Display,
        Error,
        Formatter,
        FromBytes,
        FromBytesDeserializer,
        FromStr,
        IoResult,
        Read,
        Serialize,
        SerializeStruct,
        Serializer,
        ToBytes,
        ToBytesSerializer,
        Write,
        de,
        error,
        fmt,
        ser,
    },
    types::Field,
};
use narwhal_subdag::Subdag;

use anyhow::Result;
use rand::{CryptoRng, Rng};

#[derive(Clone, PartialEq, Eq)]
pub enum Authority<N: Network> {
    Beacon(Signature<N>),
    Quorum(Subdag<N>),
}

impl<N: Network> Authority<N> {
    /// Initializes a new beacon authority.
    pub fn new_beacon<R: Rng + CryptoRng>(
        private_key: &PrivateKey<N>,
        block_hash: Field<N>,
        rng: &mut R,
    ) -> Result<Self> {
        // Sign the block hash.
        let signature = private_key.sign(&[block_hash], rng)?;
        // Return the beacon authority.
        Ok(Self::Beacon(signature))
    }

    /// Initializes a new quorum authority.
    pub fn new_quorum(subdag: Subdag<N>) -> Self {
        Self::Quorum(subdag)
    }
}

impl<N: Network> Authority<N> {
    /// Initializes a new beacon authority from the given signature.
    pub const fn from_beacon(signature: Signature<N>) -> Self {
        Self::Beacon(signature)
    }

    /// Initializes a new quorum authority.
    pub const fn from_quorum(subdag: Subdag<N>) -> Self {
        Self::Quorum(subdag)
    }
}

impl<N: Network> Authority<N> {
    /// Returns `true` if the authority is a beacon.
    pub const fn is_beacon(&self) -> bool {
        matches!(self, Self::Beacon(_))
    }

    /// Returns `true` if the authority is a quorum.
    pub const fn is_quorum(&self) -> bool {
        matches!(self, Self::Quorum(_))
    }
}

impl<N: Network> Authority<N> {
    /// Returns address of the authority.
    /// If the authority is a beacon, the address of the signer is returned.
    /// If the authority is a quorum, the address of the leader is returned.
    pub fn to_address(&self) -> Address<N> {
        match self {
            Self::Beacon(signature) => signature.to_address(),
            Self::Quorum(subdag) => subdag.leader_address(),
        }
    }
}

#[cfg(any(test, feature = "test-helpers"))]
pub mod test_helpers {
    use super::*;
    use console::prelude::{TestRng, Uniform};

    pub type CurrentNetwork = console::network::MainnetV0;

    /// Returns a sample beacon authority.
    pub fn sample_beacon_authority(rng: &mut TestRng) -> Authority<CurrentNetwork> {
        Authority::new_beacon(&PrivateKey::new(rng).unwrap(), Field::rand(rng), rng).unwrap()
    }

    /// Returns a sample quorum authority.
    pub fn sample_quorum_authority(rng: &mut TestRng) -> Authority<CurrentNetwork> {
        // Return the quorum authority.
        Authority::new_quorum(narwhal_subdag::test_helpers::sample_subdag(rng))
    }

    /// Returns a list of sample authorities.
    pub fn sample_authorities(rng: &mut TestRng) -> Vec<Authority<CurrentNetwork>> {
        vec![sample_beacon_authority(rng), sample_quorum_authority(rng)]
    }
}