Skip to main content

snarkvm_circuit_program/data/record/entry/
mod.rs

1// Copyright (c) 2019-2026 Provable Inc.
2// This file is part of the snarkVM library.
3
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at:
7
8// http://www.apache.org/licenses/LICENSE-2.0
9
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15
16mod equal;
17mod find;
18mod num_randomizers;
19mod to_bits;
20mod to_fields;
21
22use crate::{Access, Ciphertext, Plaintext, Visibility};
23use snarkvm_circuit_network::Aleo;
24use snarkvm_circuit_types::{Boolean, Field, environment::prelude::*};
25
26/// An entry stored in program data.
27#[derive(Clone)]
28pub enum Entry<A: Aleo, Private: Visibility<A>> {
29    /// A constant entry.
30    Constant(Plaintext<A>),
31    /// A publicly-visible entry.
32    Public(Plaintext<A>),
33    /// A private entry encrypted under the address of the record owner.
34    Private(Private),
35}
36
37impl<A: Aleo> Inject for Entry<A, Plaintext<A>> {
38    type Primitive = console::Entry<A::Network, console::Plaintext<A::Network>>;
39
40    /// Initializes a new plaintext entry from a primitive.
41    fn new(mode: Mode, plaintext: Self::Primitive) -> Self {
42        match plaintext {
43            Self::Primitive::Constant(plaintext) => Self::Constant(Plaintext::new(mode, plaintext)),
44            Self::Primitive::Public(plaintext) => Self::Public(Plaintext::new(mode, plaintext)),
45            Self::Primitive::Private(plaintext) => Self::Private(Plaintext::new(mode, plaintext)),
46        }
47    }
48}
49
50impl<A: Aleo> Inject for Entry<A, Ciphertext<A>> {
51    type Primitive = console::Entry<A::Network, console::Ciphertext<A::Network>>;
52
53    /// Initializes a new ciphertext entry from a primitive.
54    fn new(mode: Mode, plaintext: Self::Primitive) -> Self {
55        match plaintext {
56            Self::Primitive::Constant(plaintext) => Self::Constant(Plaintext::new(mode, plaintext)),
57            Self::Primitive::Public(plaintext) => Self::Public(Plaintext::new(mode, plaintext)),
58            Self::Primitive::Private(ciphertext) => Self::Private(Ciphertext::new(mode, ciphertext)),
59        }
60    }
61}
62
63impl<A: Aleo> Eject for Entry<A, Plaintext<A>> {
64    type Primitive = console::Entry<A::Network, console::Plaintext<A::Network>>;
65
66    /// Ejects the mode of the entry.
67    fn eject_mode(&self) -> Mode {
68        match self {
69            Entry::Constant(_) => Mode::Constant,
70            Entry::Public(_) => Mode::Public,
71            Entry::Private(_) => Mode::Private,
72        }
73    }
74
75    /// Ejects the entry.
76    fn eject_value(&self) -> Self::Primitive {
77        match self {
78            Entry::Constant(plaintext) => Self::Primitive::Constant(plaintext.eject_value()),
79            Entry::Public(plaintext) => Self::Primitive::Public(plaintext.eject_value()),
80            Entry::Private(plaintext) => Self::Primitive::Private(plaintext.eject_value()),
81        }
82    }
83}
84
85impl<A: Aleo> Eject for Entry<A, Ciphertext<A>> {
86    type Primitive = console::Entry<A::Network, console::Ciphertext<A::Network>>;
87
88    /// Ejects the mode of the entry.
89    fn eject_mode(&self) -> Mode {
90        match self {
91            Entry::Constant(_) => Mode::Constant,
92            Entry::Public(_) => Mode::Public,
93            Entry::Private(_) => Mode::Private,
94        }
95    }
96
97    /// Ejects the entry.
98    fn eject_value(&self) -> Self::Primitive {
99        match self {
100            Entry::Constant(plaintext) => Self::Primitive::Constant(plaintext.eject_value()),
101            Entry::Public(plaintext) => Self::Primitive::Public(plaintext.eject_value()),
102            Entry::Private(ciphertext) => Self::Primitive::Private(ciphertext.eject_value()),
103        }
104    }
105}