snarkvm-circuit-environment 4.6.2

Circuit environment 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

// 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.

#[macro_export]
macro_rules! scope {
    ($scope_name:expr, $block:block) => {
        E::scope($scope_name, || $block)
    };
}

#[macro_export]
macro_rules! print_scope {
    () => {{
        println!(
            "Circuit::scope(Constants: {:?}, Public: {:?}, Private: {:?}, Constraints: {:?})\n",
            Circuit::num_constants_in_scope(),
            Circuit::num_public_in_scope(),
            Circuit::num_private_in_scope(),
            Circuit::num_constraints_in_scope()
        );
    }};
}

#[macro_export]
macro_rules! assert_scope {
    () => {{
        $crate::print_scope!();

        assert!(Circuit::is_satisfied_in_scope(), "(is_satisfied_in_scope)");
    }};
    ($num_constants:expr, $num_public:expr, $num_private:expr, $num_constraints:expr) => {{
        $crate::print_scope!();

        assert_eq!($num_constants, Circuit::num_constants_in_scope(), "(num_constants)");
        assert_eq!($num_public, Circuit::num_public_in_scope(), "(num_public)");
        assert_eq!($num_private, Circuit::num_private_in_scope(), "(num_private)");
        assert_eq!($num_constraints, Circuit::num_constraints_in_scope(), "(num_constraints)");
        assert!(Circuit::is_satisfied_in_scope(), "(is_satisfied_in_scope)");
    }};
    (<=$num_constants:expr, $num_public:expr, $num_private:expr, $num_constraints:expr) => {{
        $crate::print_scope!();

        assert!(Circuit::num_constants_in_scope() <= $num_constants, "(num_constants)");
        assert_eq!($num_public, Circuit::num_public_in_scope(), "(num_public)");
        assert_eq!($num_private, Circuit::num_private_in_scope(), "(num_private)");
        assert_eq!($num_constraints, Circuit::num_constraints_in_scope(), "(num_constraints)");
        assert!(Circuit::is_satisfied_in_scope(), "(is_satisfied_in_scope)");
    }};
    (<=$num_constants:expr, <=$num_public:expr, <=$num_private:expr, <=$num_constraints:expr) => {{
        $crate::print_scope!();

        assert!(Circuit::num_constants_in_scope() <= $num_constants, "(num_constants)");
        assert!(Circuit::num_public_in_scope() <= $num_public, "(num_public)");
        assert!(Circuit::num_private_in_scope() <= $num_private, "(num_private)");
        assert!(Circuit::num_constraints_in_scope() <= $num_constraints, "(num_constraints)");
        assert!(Circuit::is_satisfied_in_scope(), "(is_satisfied_in_scope)");
    }};
    ($case:expr, $num_constants:expr, $num_public:expr, $num_private:expr, $num_constraints:expr) => {{
        $crate::print_scope!();

        assert_eq!($num_constants, Circuit::num_constants_in_scope(), "{} (num_constants)", $case);
        assert_eq!($num_public, Circuit::num_public_in_scope(), "{} (num_public)", $case);
        assert_eq!($num_private, Circuit::num_private_in_scope(), "{} (num_private)", $case);
        assert_eq!($num_constraints, Circuit::num_constraints_in_scope(), "{} (num_constraints)", $case);
        assert!(Circuit::is_satisfied_in_scope(), "{} (is_satisfied_in_scope)", $case);
    }};
}

#[macro_export]
macro_rules! assert_scope_fails {
    () => {{
        $crate::print_scope!();

        assert!(!Circuit::is_satisfied_in_scope(), "(!is_satisfied_in_scope)");
    }};
    ($num_constants:expr, $num_public:expr, $num_private:expr, $num_constraints:expr) => {{
        $crate::print_scope!();

        assert_eq!($num_constants, Circuit::num_constants_in_scope(), "(num_constants)");
        assert_eq!($num_public, Circuit::num_public_in_scope(), "(num_public)");
        assert_eq!($num_private, Circuit::num_private_in_scope(), "(num_private)");
        assert_eq!($num_constraints, Circuit::num_constraints_in_scope(), "(num_constraints)");
        assert!(!Circuit::is_satisfied_in_scope(), "(!is_satisfied_in_scope)");
    }};
    ($case:expr, $num_constants:expr, $num_public:expr, $num_private:expr, $num_constraints:expr) => {{
        $crate::print_scope!();

        assert_eq!($num_constants, Circuit::num_constants_in_scope(), "{} (num_constants)", $case);
        assert_eq!($num_public, Circuit::num_public_in_scope(), "{} (num_public)", $case);
        assert_eq!($num_private, Circuit::num_private_in_scope(), "{} (num_private)", $case);
        assert_eq!($num_constraints, Circuit::num_constraints_in_scope(), "{} (num_constraints)", $case);
        assert!(!Circuit::is_satisfied_in_scope(), "{} (!is_satisfied_in_scope)", $case);
    }};
}