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 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
// Copyright (C) 2019-2023 Aleo Systems 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.
mod bytes;
mod encrypt;
mod equal;
mod find;
mod from_bits;
mod from_fields;
mod num_randomizers;
mod parse;
mod serialize;
mod size_in_fields;
mod to_bits;
mod to_fields;
use crate::{Access, Ciphertext, Identifier, Literal};
use snarkvm_console_network::Network;
use snarkvm_console_types::prelude::*;
use indexmap::IndexMap;
use once_cell::sync::OnceCell;
#[derive(Clone)]
pub enum Plaintext<N: Network> {
/// A literal.
Literal(Literal<N>, OnceCell<Vec<bool>>),
/// A struct.
Struct(IndexMap<Identifier<N>, Plaintext<N>>, OnceCell<Vec<bool>>),
/// An array.
Array(Vec<Plaintext<N>>, OnceCell<Vec<bool>>),
}
impl<N: Network> From<Literal<N>> for Plaintext<N> {
/// Returns a new `Plaintext` from a `Literal`.
fn from(literal: Literal<N>) -> Self {
Self::Literal(literal, OnceCell::new())
}
}
impl<N: Network> From<&Literal<N>> for Plaintext<N> {
/// Returns a new `Plaintext` from a `&Literal`.
fn from(literal: &Literal<N>) -> Self {
Self::Literal(literal.clone(), OnceCell::new())
}
}
#[cfg(test)]
mod tests {
use super::*;
use snarkvm_console_network::Testnet3;
use snarkvm_console_types::Field;
use core::str::FromStr;
type CurrentNetwork = Testnet3;
#[test]
fn test_plaintext() -> Result<()> {
let run_test = |value: Plaintext<CurrentNetwork>| {
assert_eq!(
value.to_bits_le(),
Plaintext::<CurrentNetwork>::from_bits_le(&value.to_bits_le()).unwrap().to_bits_le()
);
assert_eq!(value, Plaintext::<CurrentNetwork>::from_fields(&value.to_fields().unwrap()).unwrap());
assert_eq!(value, Plaintext::<CurrentNetwork>::from_str(&value.to_string()).unwrap());
assert!(*value.is_equal(&value));
assert!(*!value.is_not_equal(&value));
};
let mut rng = TestRng::default();
// Test booleans.
run_test(Plaintext::<CurrentNetwork>::from_str("true")?);
run_test(Plaintext::<CurrentNetwork>::from_str("false")?);
// Test a random field element.
run_test(Plaintext::<CurrentNetwork>::Literal(
Literal::Field(Field::new(Uniform::rand(&mut rng))),
OnceCell::new(),
));
// Test a random struct with literal members.
run_test(Plaintext::<CurrentNetwork>::Struct(
IndexMap::from_iter(
vec![
(Identifier::from_str("a")?, Plaintext::<CurrentNetwork>::from_str("true")?),
(
Identifier::from_str("b")?,
Plaintext::<CurrentNetwork>::Literal(
Literal::Field(Field::new(Uniform::rand(&mut rng))),
OnceCell::new(),
),
),
]
.into_iter(),
),
OnceCell::new(),
));
// Test a random struct with array members.
run_test(Plaintext::<CurrentNetwork>::Struct(
IndexMap::from_iter(
vec![
(Identifier::from_str("a")?, Plaintext::<CurrentNetwork>::from_str("true")?),
(
Identifier::from_str("b")?,
Plaintext::<CurrentNetwork>::Array(
vec![
Plaintext::<CurrentNetwork>::from_str("true")?,
Plaintext::<CurrentNetwork>::from_str("false")?,
],
OnceCell::new(),
),
),
]
.into_iter(),
),
OnceCell::new(),
));
// Test random deeply-nested struct.
run_test(Plaintext::<CurrentNetwork>::Struct(
IndexMap::from_iter(
vec![
(Identifier::from_str("a")?, Plaintext::<CurrentNetwork>::from_str("true")?),
(
Identifier::from_str("b")?,
Plaintext::<CurrentNetwork>::Struct(
IndexMap::from_iter(
vec![
(Identifier::from_str("c")?, Plaintext::<CurrentNetwork>::from_str("true")?),
(
Identifier::from_str("d")?,
Plaintext::<CurrentNetwork>::Struct(
IndexMap::from_iter(
vec![
(
Identifier::from_str("e")?,
Plaintext::<CurrentNetwork>::from_str("true")?,
),
(
Identifier::from_str("f")?,
Plaintext::<CurrentNetwork>::Literal(
Literal::Field(Field::new(Uniform::rand(&mut rng))),
OnceCell::new(),
),
),
]
.into_iter(),
),
OnceCell::new(),
),
),
(
Identifier::from_str("g")?,
Plaintext::Array(
vec![
Plaintext::<CurrentNetwork>::from_str("true")?,
Plaintext::<CurrentNetwork>::from_str("false")?,
],
OnceCell::new(),
),
),
]
.into_iter(),
),
OnceCell::new(),
),
),
(
Identifier::from_str("h")?,
Plaintext::<CurrentNetwork>::Literal(
Literal::Field(Field::new(Uniform::rand(&mut rng))),
OnceCell::new(),
),
),
]
.into_iter(),
),
OnceCell::new(),
));
// Test an array of literals.
run_test(Plaintext::<CurrentNetwork>::Array(
vec![
Plaintext::<CurrentNetwork>::from_str("0field")?,
Plaintext::<CurrentNetwork>::from_str("1field")?,
Plaintext::<CurrentNetwork>::from_str("2field")?,
Plaintext::<CurrentNetwork>::from_str("3field")?,
Plaintext::<CurrentNetwork>::from_str("4field")?,
],
OnceCell::new(),
));
// Test an array of structs.
run_test(Plaintext::<CurrentNetwork>::Array(
vec![
Plaintext::<CurrentNetwork>::from_str("{ x: 0field, y: 1field }")?,
Plaintext::<CurrentNetwork>::from_str("{ x: 2field, y: 3field }")?,
Plaintext::<CurrentNetwork>::from_str("{ x: 4field, y: 5field }")?,
Plaintext::<CurrentNetwork>::from_str("{ x: 6field, y: 7field }")?,
Plaintext::<CurrentNetwork>::from_str("{ x: 8field, y: 9field }")?,
],
OnceCell::new(),
));
// Test a non-uniform array.
run_test(Plaintext::<CurrentNetwork>::Array(
vec![
Plaintext::<CurrentNetwork>::from_str("true")?,
Plaintext::<CurrentNetwork>::from_str("1field")?,
Plaintext::<CurrentNetwork>::from_str("{ x: 4field, y: 1u8 }")?,
],
OnceCell::new(),
));
Ok(())
}
}