snarkvm_ledger_block/solutions/
serialize.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
// 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.

use super::*;

impl<N: Network> Serialize for Solutions<N> {
    /// Serializes the solutions 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 solutions = serializer.serialize_struct("Solutions", 1 + self.solutions.is_some() as usize)?;
                solutions.serialize_field("version", &1u8)?;
                if let Some(s) = &self.solutions {
                    solutions.serialize_field("solutions", s)?;
                }
                solutions.end()
            }
            false => ToBytesSerializer::serialize_with_size_encoding(self, serializer),
        }
    }
}

impl<'de, N: Network> Deserialize<'de> for Solutions<N> {
    /// Deserializes the solutions from a JSON-string or buffer.
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        match deserializer.is_human_readable() {
            true => {
                // Deserialize the solutions into a JSON value.
                let mut solutions = serde_json::Value::deserialize(deserializer)?;

                // Retrieve the version.
                let version: u8 = DeserializeExt::take_from_value::<D>(&mut solutions, "version")?;
                // Ensure the version is valid.
                if version != 1 {
                    return Err(de::Error::custom(format!("Invalid solutions version ({version})")));
                }

                // Retrieve the solutions, if it exists.
                Ok(Self {
                    solutions: serde_json::from_value(
                        solutions.get_mut("solutions").unwrap_or(&mut serde_json::Value::Null).take(),
                    )
                    .map_err(de::Error::custom)?,
                })
            }
            false => FromBytesDeserializer::<Self>::deserialize_with_size_encoding(deserializer, "solutions"),
        }
    }
}

#[cfg(test)]
pub(super) mod tests {
    use super::*;
    use console::account::{Address, PrivateKey};
    use ledger_puzzle::{PartialSolution, Solution};

    type CurrentNetwork = console::network::MainnetV0;

    pub(crate) fn sample_solutions(rng: &mut TestRng) -> Solutions<CurrentNetwork> {
        // Sample a new solutions.
        let mut solutions = vec![];
        for _ in 0..rng.gen_range(1..=CurrentNetwork::MAX_SOLUTIONS) {
            let private_key = PrivateKey::<CurrentNetwork>::new(rng).unwrap();
            let address = Address::try_from(private_key).unwrap();
            let partial_solution = PartialSolution::new(rng.gen(), address, u64::rand(rng)).unwrap();
            solutions.push(Solution::new(partial_solution, u64::rand(rng)));
        }
        Solutions::new(PuzzleSolutions::new(solutions).unwrap()).unwrap()
    }

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

        // Sample a new solutions.
        let expected = sample_solutions(rng);

        // Serialize
        let expected_string = &expected.to_string();
        let candidate_string = serde_json::to_string(&expected)?;
        assert_eq!(expected, serde_json::from_str(&candidate_string)?);

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

        Ok(())
    }

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

        // Sample a new solutions.
        let expected = sample_solutions(rng);

        // 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, Solutions::read_le(&expected_bytes[..])?);
        assert_eq!(expected, bincode::deserialize(&expected_bytes_with_size_encoding[..])?);

        Ok(())
    }
}