snarkvm_ledger_puzzle/solution_id/
string.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
// 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::*;

pub static SOLUTION_ID_PREFIX: &str = "solution";

impl<N: Network> FromStr for SolutionID<N> {
    type Err = Error;

    /// Reads in the solution ID string.
    fn from_str(solution_id: &str) -> Result<Self, Self::Err> {
        // Decode the solution ID string from bech32m.
        let (hrp, data, variant) = bech32::decode(solution_id)?;
        if hrp != SOLUTION_ID_PREFIX {
            bail!("Failed to decode solution ID: '{hrp}' is an invalid prefix")
        } else if data.is_empty() {
            bail!("Failed to decode solution ID: data field is empty")
        } else if variant != bech32::Variant::Bech32m {
            bail!("Found a solution ID that is not bech32m encoded: {solution_id}");
        }
        // Decode the solution ID data from u5 to u8, and into the solution ID.
        Ok(Self::read_le(&Vec::from_base32(&data)?[..])?)
    }
}

impl<N: Network> Debug for SolutionID<N> {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        Display::fmt(self, f)
    }
}

impl<N: Network> Display for SolutionID<N> {
    /// Writes the solution ID as a bech32m string.
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        // Convert the solution ID to bytes.
        let bytes = self.to_bytes_le().map_err(|_| fmt::Error)?;
        // Encode the bytes into bech32m.
        let string =
            bech32::encode(SOLUTION_ID_PREFIX, bytes.to_base32(), bech32::Variant::Bech32m).map_err(|_| fmt::Error)?;
        // Output the string.
        Display::fmt(&string, f)
    }
}

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

    type CurrentNetwork = MainnetV0;

    const ITERATIONS: u64 = 1_000;

    #[test]
    fn test_string() -> Result<()> {
        // Ensure type and empty value fails.
        assert!(SolutionID::<CurrentNetwork>::from_str(&format!("{SOLUTION_ID_PREFIX}1")).is_err());
        assert!(SolutionID::<CurrentNetwork>::from_str("").is_err());

        let mut rng = TestRng::default();

        for _ in 0..ITERATIONS {
            // Sample a new solution ID.
            let expected = SolutionID::<CurrentNetwork>::from(rng.gen::<u64>());

            // Check the string representation.
            let candidate = format!("{expected}");
            assert_eq!(expected, SolutionID::from_str(&candidate)?);
            assert_eq!(SOLUTION_ID_PREFIX, candidate.split('1').next().unwrap());
        }
        Ok(())
    }

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

        for _ in 0..ITERATIONS {
            // Sample a new solution ID.
            let expected = SolutionID::<CurrentNetwork>::from(rng.gen::<u64>());

            let candidate = expected.to_string();
            assert_eq!(format!("{expected}"), candidate);
            assert_eq!(SOLUTION_ID_PREFIX, candidate.split('1').next().unwrap());

            let candidate_recovered = SolutionID::<CurrentNetwork>::from_str(&candidate.to_string())?;
            assert_eq!(expected, candidate_recovered);
        }
        Ok(())
    }
}