snarkvm-circuit-program 0.9.13

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

// Copyright (C) 2019-2023 Aleo Systems Inc.
// This file is part of the snarkVM library.

// The snarkVM library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// The snarkVM library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with the snarkVM library. If not, see <https://www.gnu.org/licenses/>.

use snarkvm_circuit_network::Aleo;
use snarkvm_circuit_types::{environment::prelude::*, Boolean, Field, U8};

#[derive(Clone)]
pub struct HeaderLeaf<A: Aleo> {
    /// The index of the Merkle leaf.
    index: U8<A>,
    /// The ID.
    id: Field<A>,
}

impl<A: Aleo> HeaderLeaf<A> {
    /// Returns the index of the Merkle leaf.
    pub fn index(&self) -> &U8<A> {
        &self.index
    }

    /// Returns the ID in the Merkle leaf.
    pub const fn id(&self) -> &Field<A> {
        &self.id
    }
}

impl<A: Aleo> Inject for HeaderLeaf<A> {
    type Primitive = console::HeaderLeaf<A::Network>;

    /// Initializes a new header leaf circuit from a primitive.
    fn new(mode: Mode, leaf: Self::Primitive) -> Self {
        Self { index: U8::new(mode, console::U8::new(leaf.index())), id: Field::new(mode, leaf.id()) }
    }
}

impl<A: Aleo> Eject for HeaderLeaf<A> {
    type Primitive = console::HeaderLeaf<A::Network>;

    /// Ejects the mode of the header leaf.
    fn eject_mode(&self) -> Mode {
        (&self.index, &self.id).eject_mode()
    }

    /// Ejects the header leaf.
    fn eject_value(&self) -> Self::Primitive {
        Self::Primitive::new(*self.index.eject_value(), self.id.eject_value())
    }
}

impl<A: Aleo> ToBits for HeaderLeaf<A> {
    type Boolean = Boolean<A>;

    /// Outputs the little-endian bit representation of `self` *without* trailing zeros.
    fn to_bits_le(&self) -> Vec<Self::Boolean> {
        let mut bits_le = self.index.to_bits_le();
        bits_le.extend(self.id.to_bits_le());
        bits_le
    }

    /// Outputs the big-endian bit representation of `self` *without* leading zeros.
    fn to_bits_be(&self) -> Vec<Self::Boolean> {
        let mut bits_be = self.index.to_bits_be();
        bits_be.extend(self.id.to_bits_be());
        bits_be
    }
}