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
// 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.
use super::*;
impl<N: Network> Stack<N> {
/// Returns a value for the given value type.
pub fn sample_value<R: Rng + CryptoRng>(
&self,
burner_address: &Address<N>,
value_type: &ValueType<N>,
rng: &mut R,
) -> Result<Value<N>> {
match value_type {
ValueType::Constant(plaintext_type)
| ValueType::Public(plaintext_type)
| ValueType::Private(plaintext_type) => Ok(Value::Plaintext(self.sample_plaintext(plaintext_type, rng)?)),
ValueType::Record(record_name) => {
Ok(Value::Record(self.sample_record(burner_address, record_name, rng)?))
}
ValueType::ExternalRecord(locator) => {
bail!("Illegal operation: Cannot sample external records (for '{locator}.record').")
}
ValueType::Future(locator) => bail!("Illegal operation: Cannot sample futures (for '{locator}.future')."),
}
}
/// Returns a record for the given record name, with the given burner address.
pub fn sample_record<R: Rng + CryptoRng>(
&self,
burner_address: &Address<N>,
record_name: &Identifier<N>,
rng: &mut R,
) -> Result<Record<N, Plaintext<N>>> {
// Sample a record.
let record = self.sample_record_internal(burner_address, record_name, 0, rng)?;
// Ensure the record matches the value type.
self.matches_record(&record, record_name)?;
// Return the record.
Ok(record)
}
/// Samples a plaintext value according to the given plaintext type.
pub fn sample_plaintext<R: Rng + CryptoRng>(
&self,
plaintext_type: &PlaintextType<N>,
rng: &mut R,
) -> Result<Plaintext<N>> {
// Sample a plaintext value.
let plaintext = self.sample_plaintext_internal(plaintext_type, 0, rng)?;
// Ensure the plaintext value matches the plaintext type.
self.matches_plaintext(&plaintext, plaintext_type)?;
// Return the plaintext value.
Ok(plaintext)
}
}
impl<N: Network> Stack<N> {
/// Returns a record for the given record name.
fn sample_record_internal<R: Rng + CryptoRng>(
&self,
burner_address: &Address<N>,
record_name: &Identifier<N>,
depth: usize,
rng: &mut R,
) -> Result<Record<N, Plaintext<N>>> {
// If the depth exceeds the maximum depth, then the plaintext type is invalid.
ensure!(depth <= N::MAX_DATA_DEPTH, "Plaintext exceeded maximum depth of {}", N::MAX_DATA_DEPTH);
// Retrieve the record type from the program.
let record_type = self.program.get_record(record_name)?;
// Initialize the owner based on the visibility.
let owner = match record_type.owner().is_public() {
true => RecordOwner::Public(*burner_address),
false => RecordOwner::Private(Plaintext::Literal(Literal::Address(*burner_address), Default::default())),
};
// Initialize the record data according to the defined type.
let data = record_type
.entries()
.iter()
.map(|(entry_name, entry_type)| {
// Sample the entry value.
let entry = self.sample_entry_internal(entry_type, depth + 1, rng)?;
// Return the entry.
Ok((*entry_name, entry))
})
.collect::<Result<IndexMap<_, _>>>()?;
// Initialize the nonce.
let nonce = Group::rand(rng);
// Return the record.
Record::<N, Plaintext<N>>::from_plaintext(owner, data, nonce)
}
/// Samples an entry according to the given entry type.
fn sample_entry_internal<R: Rng + CryptoRng>(
&self,
entry_type: &EntryType<N>,
depth: usize,
rng: &mut R,
) -> Result<Entry<N, Plaintext<N>>> {
// If the depth exceeds the maximum depth, then the entry type is invalid.
ensure!(depth <= N::MAX_DATA_DEPTH, "Entry exceeded maximum depth of {}", N::MAX_DATA_DEPTH);
match entry_type {
EntryType::Constant(plaintext_type)
| EntryType::Public(plaintext_type)
| EntryType::Private(plaintext_type) => {
// Sample the plaintext value.
let plaintext = self.sample_plaintext_internal(plaintext_type, depth, rng)?;
// Return the entry.
match entry_type {
EntryType::Constant(..) => Ok(Entry::Constant(plaintext)),
EntryType::Public(..) => Ok(Entry::Public(plaintext)),
EntryType::Private(..) => Ok(Entry::Private(plaintext)),
}
}
}
}
/// Samples a plaintext value according to the given plaintext type.
fn sample_plaintext_internal<R: Rng + CryptoRng>(
&self,
plaintext_type: &PlaintextType<N>,
depth: usize,
rng: &mut R,
) -> Result<Plaintext<N>> {
// If the depth exceeds the maximum depth, then the plaintext type is invalid.
ensure!(depth <= N::MAX_DATA_DEPTH, "Plaintext exceeded maximum depth of {}", N::MAX_DATA_DEPTH);
// Sample the plaintext value.
let plaintext = match plaintext_type {
// Sample a literal.
PlaintextType::Literal(literal_type) => {
Plaintext::Literal(Literal::sample(*literal_type, rng), Default::default())
}
// Sample a struct.
PlaintextType::Struct(struct_name) => {
// Retrieve the struct.
let struct_ = self.program.get_struct(struct_name)?;
// Sample each member of the struct.
let members = struct_
.members()
.iter()
.map(|(member_name, member_type)| {
// Sample the member value.
let member = self.sample_plaintext_internal(member_type, depth + 1, rng)?;
// Return the member.
Ok((*member_name, member))
})
.collect::<Result<IndexMap<_, _>>>()?;
Plaintext::Struct(members, Default::default())
}
// Sample an array.
PlaintextType::Array(array_type) => {
// Sample each element of the array.
let elements = (0..**array_type.length())
.map(|_| {
// Sample the element value.
self.sample_plaintext_internal(array_type.next_element_type(), depth + 1, rng)
})
.collect::<Result<Vec<_>>>()?;
Plaintext::Array(elements, Default::default())
}
};
// Return the plaintext.
Ok(plaintext)
}
}