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
// 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.
use super::*;
use anyhow::Context;
impl<N: Network> Package<N> {
/// Executes a program function with the given inputs.
#[allow(clippy::type_complexity)]
pub fn execute<A: crate::circuit::Aleo<Network = N, BaseField = N::Field>, R: Rng + CryptoRng>(
&self,
endpoint: String,
private_key: &PrivateKey<N>,
function_name: Identifier<N>,
inputs: &[Value<N>],
rng: &mut R,
) -> Result<(Response<N>, Execution<N>, Vec<CallMetrics<N>>)> {
// Retrieve the main program.
let program = self.program();
// Retrieve the program ID.
let program_id = program.id();
// Ensure that the function exists.
if !program.contains_function(&function_name) {
bail!("Function '{function_name}' does not exist.")
}
// Build the package, if the package requires building.
self.build::<A>()?;
// Prepare the locator (even if logging is disabled, to sanity check the locator is well-formed).
let locator = Locator::<N>::from_str(&format!("{program_id}/{function_name}"))?;
dev_println!("🚀 Executing '{}'...\n", locator.to_string());
// Prepare the query.
let query = Query::<_, BlockMemory<_>>::try_from(endpoint).with_context(|| "Failed to parse endpoint")?;
// Fetch the consensus version.
let consensus_version = N::CONSENSUS_VERSION(query.current_block_height()?)?;
// Construct the process.
let process = self.get_process()?;
// Authorize the function call.
let authorization = process.authorize::<A, R>(private_key, program_id, function_name, inputs.iter(), rng)?;
// Retrieve the program.
let stack = process.get_stack(program_id)?;
let program = stack.program();
// Retrieve the function from the program.
let function = program.get_function(&function_name)?;
// Save all the prover and verifier files for any function calls that are made.
for instruction in function.instructions() {
// Note: `CallDynamic` is not handled here because its targets are resolved at runtime,
// so we cannot preload prover/verifier files for dynamic calls at execution time.
if let Instruction::Call(call) = instruction {
// Retrieve the external stack and resource.
let (external_stack, resource) = match call.operator() {
CallOperator::Locator(locator) => {
(Some(process.get_stack(locator.program_id())?), locator.resource())
}
CallOperator::Resource(resource) => (None, resource),
};
// Retrieve the program.
let program = match &external_stack {
Some(external_stack) => external_stack.program(),
None => program,
};
// If this is a function call, save its corresponding prover and verifier files.
if program.contains_function(resource) {
// Set the function name to the resource, in this scope.
let function_name = resource;
// Prepare the build directory for the imported program.
let import_build_directory =
self.build_directory().join(format!("{}-{}", program.id().name(), program.id().network()));
// Create the prover.
let prover = ProverFile::open(&import_build_directory, function_name)?;
// Adds the proving key to the process.
process.insert_proving_key(program.id(), function_name, prover.proving_key().clone())?;
// Create the verifier.
let verifier = VerifierFile::open(&import_build_directory, function_name)?;
// Adds the verifying key to the process.
process.insert_verifying_key(program.id(), function_name, verifier.verifying_key().clone())?;
}
}
}
// Prepare the build directory.
let build_directory = self.build_directory();
// Load the prover.
let prover = ProverFile::open(&build_directory, &function_name)?;
// Load the verifier.
let verifier = VerifierFile::open(&build_directory, &function_name)?;
// Adds the proving key to the process.
process.insert_proving_key(program_id, &function_name, prover.proving_key().clone())?;
// Adds the verifying key to the process.
process.insert_verifying_key(program_id, &function_name, verifier.verifying_key().clone())?;
// Execute the circuit.
let (response, mut trace) = process.execute::<A, R>(authorization, rng)?;
// Retrieve the call metrics.
let call_metrics = trace.call_metrics().to_vec();
// Determine which Varuna version to use.
let varuna_version = match (ConsensusVersion::V1..=ConsensusVersion::V3).contains(&consensus_version) {
true => VarunaVersion::V1,
false => VarunaVersion::V2,
};
// Prepare the trace.
trace.prepare(&query)?;
// Prove the execution.
let execution = trace.prove_execution::<A, R>(&locator.to_string(), varuna_version, rng)?;
// Return the response, execution, and call metrics.
Ok((response, execution, call_metrics))
}
}
#[cfg(test)]
mod tests {
use super::*;
use snarkvm_utilities::TestRng;
type CurrentAleo = snarkvm_circuit::network::AleoV0;
// TODO: Re-enable this test after `mainnet`.
#[test]
#[ignore]
fn test_execute() {
// Samples a new package at a temporary directory.
let (directory, package) = crate::package::test_helpers::sample_token_package();
// Ensure the build directory does *not* exist.
assert!(!package.build_directory().exists());
// Build the package.
package.build::<CurrentAleo>().unwrap();
// Ensure the build directory exists.
assert!(package.build_directory().exists());
// Initialize an RNG.
let rng = &mut TestRng::default();
// Sample the function inputs.
let (private_key, function_name, inputs) =
crate::package::test_helpers::sample_package_run(package.program_id());
// Construct the endpoint.
let endpoint = "https://api.explorer.aleo.org/v1".to_string();
// Run the program function.
let (_response, _execution, _metrics) =
package.execute::<CurrentAleo, _>(endpoint, &private_key, function_name, &inputs, rng).unwrap();
// Proactively remove the temporary directory (to conserve space).
std::fs::remove_dir_all(directory).unwrap();
}
// TODO: Re-enable this test using a mock API endpoint for the `Query` struct.
#[test]
#[ignore]
fn test_execute_with_import() {
// Samples a new package at a temporary directory.
let (directory, package) = crate::package::test_helpers::sample_wallet_package();
// Ensure the build directory does *not* exist.
assert!(!package.build_directory().exists());
// Build the package.
package.build::<CurrentAleo>().unwrap();
// Ensure the build directory exists.
assert!(package.build_directory().exists());
// Initialize an RNG.
let rng = &mut TestRng::default();
// Sample the function inputs.
let (private_key, function_name, inputs) =
crate::package::test_helpers::sample_package_run(package.program_id());
// Construct the endpoint.
let endpoint = "https://api.explorer.aleo.org/v1".to_string();
// Run the program function.
let (_response, _execution, _metrics) =
package.execute::<CurrentAleo, _>(endpoint, &private_key, function_name, &inputs, rng).unwrap();
// Proactively remove the temporary directory (to conserve space).
std::fs::remove_dir_all(directory).unwrap();
}
/// Use `cargo test profiler --features timer` to run this test.
#[ignore]
#[test]
fn test_profiler() -> Result<()> {
// Samples a new package at a temporary directory.
let (directory, package) = crate::package::test_helpers::sample_token_package();
// Ensure the build directory does *not* exist.
assert!(!package.build_directory().exists());
// Build the package.
package.build::<CurrentAleo>().unwrap();
// Ensure the build directory exists.
assert!(package.build_directory().exists());
// Initialize an RNG.
let rng = &mut TestRng::default();
// Sample the function inputs.
let (private_key, function_name, inputs) =
crate::package::test_helpers::sample_package_run(package.program_id());
// Construct the endpoint.
let endpoint = "https://api.explorer.aleo.org/v1".to_string();
// Run the program function.
let (_response, _execution, _metrics) =
package.execute::<CurrentAleo, _>(endpoint, &private_key, function_name, &inputs, rng).unwrap();
// Proactively remove the temporary directory (to conserve space).
std::fs::remove_dir_all(directory).unwrap();
bail!("\n\nRemember to #[ignore] this test!\n\n")
}
}