snarkvm-circuit-program 4.6.1

Program circuit library for a decentralized virtual machine
Documentation 
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
149
150
151
152
153
154
155

// Copyright (c) 2019-2026 Provable 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<A: Aleo> Literal<A> {
    /// Initializes a new literal from a list of little-endian bits *without* trailing zeros.
    pub fn from_bits_le(variant: &U8<A>, bits_le: &[Boolean<A>]) -> Self {
        let literal = bits_le;
        match *variant.eject_value() {
            0 => Literal::Address(Address::from_bits_le(literal)),
            1 => Literal::Boolean(Boolean::from_bits_le(literal)),
            2 => Literal::Field(Field::from_bits_le(literal)),
            3 => Literal::Group(Group::from_bits_le(literal)),
            4 => Literal::I8(I8::from_bits_le(literal)),
            5 => Literal::I16(I16::from_bits_le(literal)),
            6 => Literal::I32(I32::from_bits_le(literal)),
            7 => Literal::I64(I64::from_bits_le(literal)),
            8 => Literal::I128(I128::from_bits_le(literal)),
            9 => Literal::U8(U8::from_bits_le(literal)),
            10 => Literal::U16(U16::from_bits_le(literal)),
            11 => Literal::U32(U32::from_bits_le(literal)),
            12 => Literal::U64(U64::from_bits_le(literal)),
            13 => Literal::U128(U128::from_bits_le(literal)),
            14 => Literal::Scalar(Scalar::from_bits_le(literal)),
            15 => Literal::Signature(Box::new(Signature::from_bits_le(literal))),
            16 => Literal::String(StringType::from_bits_le(literal)),
            17 => Literal::Identifier(Box::new(IdentifierLiteral::from_bits_le(literal))),
            18.. => A::halt(format!("Failed to initialize literal variant {} from bits (LE)", variant.eject_value())),
        }
    }

    /// Initializes a new literal from a list of big-endian bits *without* leading zeros.
    pub fn from_bits_be(variant: &U8<A>, bits_be: &[Boolean<A>]) -> Self {
        let literal = bits_be;
        match *variant.eject_value() {
            0 => Literal::Address(Address::from_bits_be(literal)),
            1 => Literal::Boolean(Boolean::from_bits_be(literal)),
            2 => Literal::Field(Field::from_bits_be(literal)),
            3 => Literal::Group(Group::from_bits_be(literal)),
            4 => Literal::I8(I8::from_bits_be(literal)),
            5 => Literal::I16(I16::from_bits_be(literal)),
            6 => Literal::I32(I32::from_bits_be(literal)),
            7 => Literal::I64(I64::from_bits_be(literal)),
            8 => Literal::I128(I128::from_bits_be(literal)),
            9 => Literal::U8(U8::from_bits_be(literal)),
            10 => Literal::U16(U16::from_bits_be(literal)),
            11 => Literal::U32(U32::from_bits_be(literal)),
            12 => Literal::U64(U64::from_bits_be(literal)),
            13 => Literal::U128(U128::from_bits_be(literal)),
            14 => Literal::Scalar(Scalar::from_bits_be(literal)),
            15 => Literal::Signature(Box::new(Signature::from_bits_be(literal))),
            16 => Literal::String(StringType::from_bits_be(literal)),
            17 => Literal::Identifier(Box::new(IdentifierLiteral::from_bits_be(literal))),
            18.. => A::halt(format!("Failed to initialize literal variant {} from bits (BE))", variant.eject_value())),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::Circuit;
    use console::{TestRng, Uniform};

    const ITERATIONS: u32 = 10;

    fn check_serialization(expected: Literal<Circuit>) {
        // Success cases.
        assert_eq!(
            expected.eject_value(),
            Literal::from_bits_le(&expected.variant(), &expected.to_bits_le()).eject_value()
        );
        assert_eq!(
            expected.eject_value(),
            Literal::from_bits_be(&expected.variant(), &expected.to_bits_be()).eject_value()
        );

        // // Failure cases.
        // assert!(std::panic::catch_unwind(|| Literal::from_bits_le(&expected.variant(), &expected.to_bits_be()).eject_value()).is_err());
        // Circuit::reset();
        // assert!(std::panic::catch_unwind(|| Literal::from_bits_be(&expected.variant(), &expected.to_bits_le()).eject_value()).is_err());
        Circuit::reset();
    }

    fn run_serialization_test(mode: Mode) {
        let rng = &mut TestRng::default();

        for _ in 0..ITERATIONS {
            // Address
            check_serialization(Literal::<Circuit>::Address(Address::new(mode, console::Address::rand(rng))));
            // Boolean
            check_serialization(Literal::<Circuit>::Boolean(Boolean::new(mode, Uniform::rand(rng))));
            // Field
            check_serialization(Literal::<Circuit>::Field(Field::new(mode, Uniform::rand(rng))));
            // Group
            check_serialization(Literal::<Circuit>::Group(Group::new(mode, Uniform::rand(rng))));
            // I8
            check_serialization(Literal::<Circuit>::I8(I8::new(mode, Uniform::rand(rng))));
            // I16
            check_serialization(Literal::<Circuit>::I16(I16::new(mode, Uniform::rand(rng))));
            // I32
            check_serialization(Literal::<Circuit>::I32(I32::new(mode, Uniform::rand(rng))));
            // I64
            check_serialization(Literal::<Circuit>::I64(I64::new(mode, Uniform::rand(rng))));
            // I128
            check_serialization(Literal::<Circuit>::I128(I128::new(mode, Uniform::rand(rng))));
            // U8
            check_serialization(Literal::<Circuit>::U8(U8::new(mode, Uniform::rand(rng))));
            // U16
            check_serialization(Literal::<Circuit>::U16(U16::new(mode, Uniform::rand(rng))));
            // U32
            check_serialization(Literal::<Circuit>::U32(U32::new(mode, Uniform::rand(rng))));
            // U64
            check_serialization(Literal::<Circuit>::U64(U64::new(mode, Uniform::rand(rng))));
            // U128
            check_serialization(Literal::<Circuit>::U128(U128::new(mode, Uniform::rand(rng))));
            // Scalar
            check_serialization(Literal::<Circuit>::Scalar(Scalar::new(mode, Uniform::rand(rng))));
            // Signature
            check_serialization(Literal::new(mode, console::Literal::sample(LiteralType::Signature, rng)));
            // String
            // Sample a random string. Take 1/4th to ensure we fit for all code points.
            let string = rng.next_string(Circuit::MAX_STRING_BYTES / 4, false);
            check_serialization(Literal::<Circuit>::String(StringType::new(mode, console::StringType::new(&string))));
        }
    }

    #[test]
    fn test_serialization_constant() {
        run_serialization_test(Mode::Constant);
    }

    #[test]
    fn test_serialization_public() {
        run_serialization_test(Mode::Public);
    }

    #[test]
    fn test_serialization_private() {
        run_serialization_test(Mode::Private);
    }
}