casper-binary-port 1.1.1

Types for the casper node binary port
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

use std::collections::BTreeMap;
#[cfg(test)]
use std::{collections::VecDeque, iter::FromIterator};

#[cfg(test)]
use casper_types::testing::TestRng;
use casper_types::{
    bytesrepr::{self, FromBytes, ToBytes},
    global_state::TrieMerkleProof,
    system::mint::BalanceHoldAddrTag,
    BlockTime, Key, StoredValue, U512,
};
#[cfg(test)]
use casper_types::{global_state::TrieMerkleProofStep, CLValue};
#[cfg(test)]
use rand::Rng;

/// Response to a balance query.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct BalanceResponse {
    /// The purses total balance, not considering holds.
    pub total_balance: U512,
    /// The available balance (total balance - sum of all active holds).
    pub available_balance: U512,
    /// A proof that the given value is present in the Merkle trie.
    pub total_balance_proof: Box<TrieMerkleProof<Key, StoredValue>>,
    /// Any time-relevant active holds on the balance.
    pub balance_holds: BTreeMap<BlockTime, BalanceHoldsWithProof>,
}

impl BalanceResponse {
    #[cfg(test)]
    pub(crate) fn random(rng: &mut TestRng) -> Self {
        BalanceResponse {
            total_balance: rng.gen(),
            available_balance: rng.gen(),
            total_balance_proof: Box::new(TrieMerkleProof::new(
                Key::URef(rng.gen()),
                StoredValue::CLValue(CLValue::from_t(rng.gen::<i32>()).unwrap()),
                VecDeque::from_iter([TrieMerkleProofStep::random(rng)]),
            )),
            balance_holds: BTreeMap::new(),
        }
    }
}

impl ToBytes for BalanceResponse {
    fn to_bytes(&self) -> Result<Vec<u8>, casper_types::bytesrepr::Error> {
        let mut buffer = bytesrepr::allocate_buffer(self)?;
        self.write_bytes(&mut buffer)?;
        Ok(buffer)
    }

    fn write_bytes(&self, writer: &mut Vec<u8>) -> Result<(), casper_types::bytesrepr::Error> {
        self.total_balance.write_bytes(writer)?;
        self.available_balance.write_bytes(writer)?;
        self.total_balance_proof.write_bytes(writer)?;
        self.balance_holds.write_bytes(writer)
    }

    fn serialized_length(&self) -> usize {
        self.total_balance.serialized_length()
            + self.available_balance.serialized_length()
            + self.total_balance_proof.serialized_length()
            + self.balance_holds.serialized_length()
    }
}

impl FromBytes for BalanceResponse {
    fn from_bytes(bytes: &[u8]) -> Result<(Self, &[u8]), casper_types::bytesrepr::Error> {
        let (total_balance, remainder) = U512::from_bytes(bytes)?;
        let (available_balance, remainder) = U512::from_bytes(remainder)?;
        let (total_balance_proof, remainder) =
            TrieMerkleProof::<Key, StoredValue>::from_bytes(remainder)?;
        let (balance_holds, remainder) =
            BTreeMap::<BlockTime, BalanceHoldsWithProof>::from_bytes(remainder)?;
        Ok((
            BalanceResponse {
                total_balance,
                available_balance,
                total_balance_proof: Box::new(total_balance_proof),
                balance_holds,
            },
            remainder,
        ))
    }
}

/// Balance holds with Merkle proofs.
pub type BalanceHoldsWithProof =
    BTreeMap<BalanceHoldAddrTag, (U512, TrieMerkleProof<Key, StoredValue>)>;

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

    #[test]
    fn bytesrepr_roundtrip() {
        let rng = &mut TestRng::new();

        let val = BalanceResponse::random(rng);
        bytesrepr::test_serialization_roundtrip(&val);
    }
}