snarkvm_console_program/id/
to_bits.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
// 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> ToBits for ProgramID<N> {
    /// Returns the little-endian bits of the program ID.
    fn write_bits_le(&self, vec: &mut Vec<bool>) {
        (&self).write_bits_le(vec);
    }

    /// Returns the big-endian bits of the program ID.
    fn write_bits_be(&self, vec: &mut Vec<bool>) {
        (&self).write_bits_be(vec);
    }
}

impl<N: Network> ToBits for &ProgramID<N> {
    /// Returns the little-endian bits of the program ID.
    fn write_bits_le(&self, vec: &mut Vec<bool>) {
        self.name().write_bits_le(vec);
        self.network().write_bits_le(vec);
    }

    /// Returns the big-endian bits of the program ID.
    fn write_bits_be(&self, vec: &mut Vec<bool>) {
        self.name().write_bits_be(vec);
        self.network().write_bits_be(vec);
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::data::identifier::tests::sample_lowercase_identifier_as_string;
    use snarkvm_console_network::MainnetV0;

    type CurrentNetwork = MainnetV0;

    const ITERATIONS: usize = 100;

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

        for _ in 0..ITERATIONS {
            // Sample a random fixed-length alphanumeric string, that always starts with an alphabetic character.
            let expected_name_string = sample_lowercase_identifier_as_string::<CurrentNetwork>(&mut rng)?;
            // Recover the field element from the bits.
            let expected_name_field = Field::<CurrentNetwork>::from_bits_le(&expected_name_string.to_bits_le())?;
            let expected_network_field = Field::<CurrentNetwork>::from_bits_le(&"aleo".to_string().to_bits_le())?;
            // Compute the expected bits.
            let mut expected_bits = expected_name_field.to_bits_le()[..expected_name_string.len() * 8].to_vec();
            expected_bits.extend(&expected_network_field.to_bits_le()[..4 * 8]);

            let candidate = ProgramID::<CurrentNetwork>::from_str(&format!("{expected_name_string}.aleo"))?;
            assert_eq!(
                expected_name_field.to_bits_le()[..expected_name_string.len() * 8],
                candidate.name().to_bits_le()
            );
            assert_eq!(expected_network_field.to_bits_le()[..4 * 8], candidate.network().to_bits_le());
            assert_eq!(expected_bits, candidate.to_bits_le());
        }
        Ok(())
    }

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

        for _ in 0..ITERATIONS {
            // Sample a random fixed-length alphanumeric string, that always starts with an alphabetic character.
            let expected_name_string = sample_lowercase_identifier_as_string::<CurrentNetwork>(&mut rng)?;
            // Recover the field element from the bits.
            let expected_name_field = Field::<CurrentNetwork>::from_bits_le(&expected_name_string.to_bits_le())?;
            let expected_network_field = Field::<CurrentNetwork>::from_bits_le(&"aleo".to_string().to_bits_le())?;
            // Compute the expected bits.
            let mut expected_bits = expected_name_field.to_bits_le()[..expected_name_string.len() * 8]
                .iter()
                .rev()
                .copied()
                .collect::<Vec<_>>();
            expected_bits.extend(expected_network_field.to_bits_le()[..4 * 8].iter().rev().copied());

            let candidate = ProgramID::<CurrentNetwork>::from_str(&format!("{expected_name_string}.aleo"))?;
            assert_eq!(
                expected_name_field.to_bits_le()[..expected_name_string.len() * 8]
                    .iter()
                    .rev()
                    .copied()
                    .collect::<Vec<_>>(),
                candidate.name().to_bits_be()
            );
            assert_eq!(
                expected_network_field.to_bits_le()[..4 * 8].iter().rev().copied().collect::<Vec<_>>(),
                candidate.network().to_bits_be()
            );
            assert_eq!(expected_bits, candidate.to_bits_be());
        }
        Ok(())
    }
}