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 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
// Copyright (C) 2019-2023 Aleo Systems Inc.
// This file is part of the Aleo SDK library.
// The Aleo SDK 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 Aleo SDK 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 Aleo SDK library. If not, see <https://www.gnu.org/licenses/>.
use super::*;
use core::ops::Add;
use crate::{
execute_fee,
execute_program,
log,
process_inputs,
ExecutionResponse,
OfflineQuery,
PrivateKey,
RecordPlaintext,
Transaction,
};
use crate::types::native::{
CurrentAleo,
IdentifierNative,
ProcessNative,
ProgramNative,
RecordPlaintextNative,
TransactionNative,
};
use js_sys::{Array, Object};
use rand::{rngs::StdRng, SeedableRng};
use std::str::FromStr;
#[wasm_bindgen]
impl ProgramManager {
/// Execute an arbitrary function locally
///
/// @param {PrivateKey} private_key The private key of the sender
/// @param {string} program The source code of the program being executed
/// @param {string} function The name of the function to execute
/// @param {Array} inputs A javascript array of inputs to the function
/// @param {boolean} prove_execution If true, the execution will be proven and an execution object
/// containing the proof and the encrypted inputs and outputs needed to verify the proof offline
/// will be returned.
/// @param {boolean} cache Cache the proving and verifying keys in the Execution response.
/// If this is set to 'true' the keys synthesized will be stored in the Execution Response
/// and the `ProvingKey` and `VerifyingKey` can be retrieved from the response via the `.getKeys()`
/// method.
/// @param {Object | undefined} imports (optional) Provide a list of imports to use for the function execution in the
/// form of a javascript object where the keys are a string of the program name and the values
/// are a string representing the program source code \{ "hello.aleo": "hello.aleo source code" \}
/// @param {ProvingKey | undefined} proving_key (optional) Provide a verifying key to use for the function execution
/// @param {VerifyingKey | undefined} verifying_key (optional) Provide a verifying key to use for the function execution
#[wasm_bindgen(js_name = executeFunctionOffline)]
#[allow(clippy::too_many_arguments)]
pub async fn execute_function_offline(
private_key: &PrivateKey,
program: &str,
function: &str,
inputs: Array,
prove_execution: bool,
cache: bool,
imports: Option<Object>,
proving_key: Option<ProvingKey>,
verifying_key: Option<VerifyingKey>,
url: Option<String>,
offline_query: Option<OfflineQuery>,
) -> Result<ExecutionResponse, String> {
log(&format!("Executing local function: {function}"));
let node_url = url.as_deref().unwrap_or(DEFAULT_URL);
let inputs = inputs.to_vec();
let rng = &mut StdRng::from_entropy();
let mut process_native = ProcessNative::load_web().map_err(|err| err.to_string())?;
let process = &mut process_native;
log("Check program imports are valid and add them to the process");
let program_native = ProgramNative::from_str(program).map_err(|e| e.to_string())?;
ProgramManager::resolve_imports(process, &program_native, imports)?;
let (response, mut trace) = execute_program!(
process,
process_inputs!(inputs),
program,
function,
private_key,
proving_key,
verifying_key,
rng
);
let mut execution_response = if prove_execution {
log("Preparing inclusion proofs for execution");
if let Some(offline_query) = offline_query {
trace.prepare_async(offline_query).await.map_err(|err| err.to_string())?;
} else {
let query = QueryNative::from(node_url);
trace.prepare_async(query).await.map_err(|err| err.to_string())?;
}
log("Proving execution");
let locator = program_native.id().to_string().add("/").add(function);
let execution = trace.prove_execution::<CurrentAleo, _>(&locator, rng).map_err(|e| e.to_string())?;
ExecutionResponse::new(Some(execution), function, response, process, program)?
} else {
ExecutionResponse::new(None, function, response, process, program)?
};
if cache {
execution_response.add_proving_key(process, function, program_native.id())?;
}
Ok(execution_response)
}
/// Execute Aleo function and create an Aleo execution transaction
///
/// @param private_key The private key of the sender
/// @param program The source code of the program being executed
/// @param function The name of the function to execute
/// @param inputs A javascript array of inputs to the function
/// @param fee_credits The amount of credits to pay as a fee
/// @param fee_record The record to spend the fee from
/// @param url The url of the Aleo network node to send the transaction to
/// If this is set to 'true' the keys synthesized (or passed in as optional parameters via the
/// `proving_key` and `verifying_key` arguments) will be stored in the ProgramManager's memory
/// and used for subsequent transactions. If this is set to 'false' the proving and verifying
/// keys will be deallocated from memory after the transaction is executed.
/// @param imports (optional) Provide a list of imports to use for the function execution in the
/// form of a javascript object where the keys are a string of the program name and the values
/// are a string representing the program source code \{ "hello.aleo": "hello.aleo source code" \}
/// @param proving_key (optional) Provide a verifying key to use for the function execution
/// @param verifying_key (optional) Provide a verifying key to use for the function execution
/// @param fee_proving_key (optional) Provide a proving key to use for the fee execution
/// @param fee_verifying_key (optional) Provide a verifying key to use for the fee execution
/// @returns {Transaction | Error}
#[wasm_bindgen(js_name = buildExecutionTransaction)]
#[allow(clippy::too_many_arguments)]
pub async fn execute(
private_key: &PrivateKey,
program: &str,
function: &str,
inputs: Array,
fee_credits: f64,
fee_record: Option<RecordPlaintext>,
url: Option<String>,
imports: Option<Object>,
proving_key: Option<ProvingKey>,
verifying_key: Option<VerifyingKey>,
fee_proving_key: Option<ProvingKey>,
fee_verifying_key: Option<VerifyingKey>,
offline_query: Option<OfflineQuery>,
) -> Result<Transaction, String> {
log(&format!("Executing function: {function} on-chain"));
let fee_microcredits = match &fee_record {
Some(fee_record) => Self::validate_amount(fee_credits, fee_record, true)?,
None => (fee_credits * 1_000_000.0) as u64,
};
let mut process_native = ProcessNative::load_web().map_err(|err| err.to_string())?;
let process = &mut process_native;
let node_url = url.as_deref().unwrap_or(DEFAULT_URL);
log("Check program imports are valid and add them to the process");
let program_native = ProgramNative::from_str(program).map_err(|e| e.to_string())?;
ProgramManager::resolve_imports(process, &program_native, imports)?;
let rng = &mut StdRng::from_entropy();
log("Executing program");
let (_, mut trace) = execute_program!(
process,
process_inputs!(inputs),
program,
function,
private_key,
proving_key,
verifying_key,
rng
);
log("Preparing inclusion proofs for execution");
if let Some(offline_query) = offline_query.as_ref() {
trace.prepare_async(offline_query.clone()).await.map_err(|err| err.to_string())?;
} else {
let query = QueryNative::from(node_url);
trace.prepare_async(query).await.map_err(|err| err.to_string())?;
}
log("Proving execution");
let program = ProgramNative::from_str(program).map_err(|err| err.to_string())?;
let locator = program.id().to_string().add("/").add(function);
let execution = trace
.prove_execution::<CurrentAleo, _>(&locator, &mut StdRng::from_entropy())
.map_err(|e| e.to_string())?;
let execution_id = execution.to_execution_id().map_err(|e| e.to_string())?;
log("Executing fee");
let fee = execute_fee!(
process,
private_key,
fee_record,
fee_microcredits,
node_url,
fee_proving_key,
fee_verifying_key,
execution_id,
rng,
offline_query
);
// Verify the execution
process.verify_execution(&execution).map_err(|err| err.to_string())?;
log("Creating execution transaction");
let transaction = TransactionNative::from_execution(execution, Some(fee)).map_err(|err| err.to_string())?;
Ok(Transaction::from(transaction))
}
/// Estimate Fee for Aleo function execution. Note if "cache" is set to true, the proving and
/// verifying keys will be stored in the ProgramManager's memory and used for subsequent
/// program executions.
///
/// Disclaimer: Fee estimation is experimental and may not represent a correct estimate on any current or future network
///
/// @param private_key The private key of the sender
/// @param program The source code of the program to estimate the execution fee for
/// @param function The name of the function to execute
/// @param inputs A javascript array of inputs to the function
/// @param url The url of the Aleo network node to send the transaction to
/// @param imports (optional) Provide a list of imports to use for the fee estimation in the
/// form of a javascript object where the keys are a string of the program name and the values
/// are a string representing the program source code \{ "hello.aleo": "hello.aleo source code" \}
/// @param proving_key (optional) Provide a verifying key to use for the fee estimation
/// @param verifying_key (optional) Provide a verifying key to use for the fee estimation
/// @returns {u64 | Error} Fee in microcredits
#[wasm_bindgen(js_name = estimateExecutionFee)]
#[allow(clippy::too_many_arguments)]
pub async fn estimate_execution_fee(
private_key: &PrivateKey,
program: &str,
function: &str,
inputs: Array,
url: Option<String>,
imports: Option<Object>,
proving_key: Option<ProvingKey>,
verifying_key: Option<VerifyingKey>,
offline_query: Option<OfflineQuery>,
) -> Result<u64, String> {
log(
"Disclaimer: Fee estimation is experimental and may not represent a correct estimate on any current or future network",
);
log(&format!("Executing local function: {function}"));
let mut process_native = ProcessNative::load_web().map_err(|err| err.to_string())?;
let process = &mut process_native;
log("Check program imports are valid and add them to the process");
let program_native = ProgramNative::from_str(program).map_err(|e| e.to_string())?;
ProgramManager::resolve_imports(process, &program_native, imports)?;
let rng = &mut StdRng::from_entropy();
log("Generating execution trace");
let (_, mut trace) = execute_program!(
process,
process_inputs!(inputs),
program,
function,
private_key,
proving_key,
verifying_key,
rng
);
// Execute the program
let node_url = url.as_deref().unwrap_or(DEFAULT_URL);
let program = ProgramNative::from_str(program).map_err(|err| err.to_string())?;
let locator = program.id().to_string().add("/").add(function);
if let Some(offline_query) = offline_query {
trace.prepare_async(offline_query).await.map_err(|err| err.to_string())?;
} else {
let query = QueryNative::from(node_url);
trace.prepare_async(query).await.map_err(|err| err.to_string())?;
}
let execution = trace.prove_execution::<CurrentAleo, _>(&locator, rng).map_err(|e| e.to_string())?;
// Get the storage cost in bytes for the program execution
log("Estimating cost");
let storage_cost = execution.size_in_bytes().map_err(|e| e.to_string())?;
// Compute the finalize cost in microcredits.
let mut finalize_cost = 0u64;
// Iterate over the transitions to accumulate the finalize cost.
for transition in execution.transitions() {
// Retrieve the function name, program id, and program.
let function_name = transition.function_name();
let program_id = transition.program_id();
let program = process.get_program(program_id).map_err(|e| e.to_string())?;
// Calculate the finalize cost for the function identified in the transition
let cost = match &program.get_function(function_name).map_err(|e| e.to_string())?.finalize_logic() {
Some(finalize) => cost_in_microcredits(finalize).map_err(|e| e.to_string())?,
None => continue,
};
// Accumulate the finalize cost.
finalize_cost = finalize_cost
.checked_add(cost)
.ok_or("The finalize cost computation overflowed for an execution".to_string())?;
}
Ok(storage_cost + finalize_cost)
}
/// Estimate the finalize fee component for executing a function. This fee is additional to the
/// size of the execution of the program in bytes. If the function does not have a finalize
/// step, then the finalize fee is 0.
///
/// Disclaimer: Fee estimation is experimental and may not represent a correct estimate on any current or future network
///
/// @param program The program containing the function to estimate the finalize fee for
/// @param function The function to estimate the finalize fee for
/// @returns {u64 | Error} Fee in microcredits
#[wasm_bindgen(js_name = estimateFinalizeFee)]
pub fn estimate_finalize_fee(program: &str, function: &str) -> Result<u64, String> {
log(
"Disclaimer: Fee estimation is experimental and may not represent a correct estimate on any current or future network",
);
let program = ProgramNative::from_str(program).map_err(|err| err.to_string())?;
let function_id = IdentifierNative::from_str(function).map_err(|err| err.to_string())?;
match program.get_function(&function_id).map_err(|err| err.to_string())?.finalize_logic() {
Some(finalize) => cost_in_microcredits(finalize).map_err(|e| e.to_string()),
None => Ok(0u64),
}
}
}