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
141
142
143
144
145
146
147
148
// Copyright (C) 2019-2023 Aleo Systems 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 super::*;

impl<N: Network> Serialize for Block<N> {
    /// Serializes the block to a JSON-string or buffer.
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        match serializer.is_human_readable() {
            true => {
                let mut block = serializer.serialize_struct("Block", 7 + self.solutions.is_some() as usize)?;
                block.serialize_field("block_hash", &self.block_hash)?;
                block.serialize_field("previous_hash", &self.previous_hash)?;
                block.serialize_field("header", &self.header)?;
                block.serialize_field("authority", &self.authority)?;
                block.serialize_field("ratifications", &self.ratifications)?;

                if let Some(solutions) = &self.solutions {
                    block.serialize_field("solutions", solutions)?;
                }

                block.serialize_field("transactions", &self.transactions)?;
                block.serialize_field("aborted_transaction_ids", &self.aborted_transaction_ids)?;
                block.end()
            }
            false => ToBytesSerializer::serialize_with_size_encoding(self, serializer),
        }
    }
}

impl<'de, N: Network> Deserialize<'de> for Block<N> {
    /// Deserializes the block from a JSON-string or buffer.
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        match deserializer.is_human_readable() {
            true => {
                let mut block = serde_json::Value::deserialize(deserializer)?;
                let block_hash: N::BlockHash = DeserializeExt::take_from_value::<D>(&mut block, "block_hash")?;

                // Retrieve the solutions.
                let solutions = block.get_mut("solutions").unwrap_or(&mut serde_json::Value::Null).take();

                // Recover the block.
                let block = Self::from(
                    DeserializeExt::take_from_value::<D>(&mut block, "previous_hash")?,
                    DeserializeExt::take_from_value::<D>(&mut block, "header")?,
                    DeserializeExt::take_from_value::<D>(&mut block, "authority")?,
                    DeserializeExt::take_from_value::<D>(&mut block, "ratifications")?,
                    serde_json::from_value(solutions).map_err(de::Error::custom)?,
                    DeserializeExt::take_from_value::<D>(&mut block, "transactions")?,
                    DeserializeExt::take_from_value::<D>(&mut block, "aborted_transaction_ids")?,
                )
                .map_err(de::Error::custom)?;

                // Ensure the block hash matches.
                match block_hash == block.hash() {
                    true => Ok(block),
                    false => Err(error("Mismatching block hash, possible data corruption")).map_err(de::Error::custom),
                }
            }
            false => FromBytesDeserializer::<Self>::deserialize_with_size_encoding(deserializer, "block"),
        }
    }
}

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

    type CurrentNetwork = Testnet3;

    #[test]
    fn test_serde_json() -> Result<()> {
        let rng = &mut TestRng::default();

        for expected in [crate::test_helpers::sample_genesis_block(rng)].into_iter() {
            // Serialize
            let expected_string = &expected.to_string();
            let candidate_string = serde_json::to_string(&expected)?;

            // Deserialize
            assert_eq!(expected, Block::from_str(expected_string)?);
            assert_eq!(expected, serde_json::from_str(&candidate_string)?);
        }
        Ok(())
    }

    #[test]
    fn test_bincode() -> Result<()> {
        let rng = &mut TestRng::default();

        for expected in [crate::test_helpers::sample_genesis_block(rng)].into_iter() {
            // Serialize
            let expected_bytes = expected.to_bytes_le()?;
            let expected_bytes_with_size_encoding = bincode::serialize(&expected)?;
            assert_eq!(&expected_bytes[..], &expected_bytes_with_size_encoding[8..]);

            // Deserialize
            assert_eq!(expected, Block::read_le(&expected_bytes[..])?);
            assert_eq!(expected, bincode::deserialize(&expected_bytes_with_size_encoding[..])?);
        }
        Ok(())
    }

    #[test]
    fn test_genesis_serde_json() -> Result<()> {
        // Load the genesis block.
        let genesis_block = Block::<CurrentNetwork>::read_le(CurrentNetwork::genesis_bytes()).unwrap();

        // Serialize
        let expected_string = &genesis_block.to_string();
        let candidate_string = serde_json::to_string(&genesis_block)?;

        // Deserialize
        assert_eq!(genesis_block, Block::from_str(expected_string)?);
        assert_eq!(genesis_block, serde_json::from_str(&candidate_string)?);

        Ok(())
    }

    #[test]
    fn test_genesis_bincode() -> Result<()> {
        // Load the genesis block.
        let genesis_block = Block::<CurrentNetwork>::read_le(CurrentNetwork::genesis_bytes()).unwrap();

        // Serialize
        let expected_bytes = genesis_block.to_bytes_le()?;
        let expected_bytes_with_size_encoding = bincode::serialize(&genesis_block)?;
        assert_eq!(&expected_bytes[..], &expected_bytes_with_size_encoding[8..]);

        // Deserialize
        assert_eq!(genesis_block, Block::read_le(&expected_bytes[..])?);
        assert_eq!(genesis_block, bincode::deserialize(&expected_bytes_with_size_encoding[..])?);

        Ok(())
    }
}