snarkvm_ledger_block/ratify/
mod.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
// 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.

mod bytes;
mod serialize;
mod string;

use console::{network::prelude::*, types::Address};
use ledger_committee::Committee;

use indexmap::IndexMap;

type Variant = u8;
/// A helper type to represent the public balances.
type PublicBalances<N> = IndexMap<Address<N>, u64>;
/// A helper type to represent the bonded balances, as a
/// mapping of `staker_address` to `(validator_address, withdrawal_address, amount)`.
type BondedBalances<N> = IndexMap<Address<N>, (Address<N>, Address<N>, u64)>;

// Note: The size of the `Ratify` object is 32 bytes.
#[derive(Clone, PartialEq, Eq)]
pub enum Ratify<N: Network> {
    /// The genesis.
    Genesis(Box<Committee<N>>, Box<PublicBalances<N>>, Box<BondedBalances<N>>),
    /// The block reward.
    BlockReward(u64),
    /// The puzzle reward.
    PuzzleReward(u64),
}

impl<N: Network> Ratify<N> {
    /// Returns the ratification ID.
    pub fn to_id(&self) -> Result<N::RatificationID> {
        Ok(N::hash_bhp1024(&self.to_bytes_le()?.to_bits_le())?.into())
    }
}

#[cfg(test)]
pub(crate) mod test_helpers {
    use super::*;
    use console::network::MainnetV0;

    type CurrentNetwork = MainnetV0;

    pub(crate) fn sample_ratifications(rng: &mut TestRng) -> Vec<Ratify<CurrentNetwork>> {
        let committee = ledger_committee::test_helpers::sample_committee(rng);
        let mut public_balances = PublicBalances::new();
        for (address, _) in committee.members().iter() {
            public_balances.insert(*address, rng.gen());
        }
        let bonded_balances = committee
            .members()
            .iter()
            .map(|(address, (amount, _, _))| (*address, (*address, *address, *amount)))
            .collect();

        vec![
            Ratify::Genesis(Box::new(committee), Box::new(public_balances), Box::new(bonded_balances)),
            Ratify::BlockReward(rng.gen()),
            Ratify::PuzzleReward(rng.gen()),
        ]
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn check_ratify_size() {
        assert_eq!(std::mem::size_of::<Ratify<console::network::MainnetV0>>(), 32);
    }
}