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
use super::{
trace::MIN_TRACE_LEN, ExecutionOptionsError, FieldExtension, HashFunction, WinterProofOptions,
};
// PROVING OPTIONS
// ================================================================================================
/// A set of parameters specifying how Miden VM execution proofs are to be generated.
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct ProvingOptions {
exec_options: ExecutionOptions,
proof_options: WinterProofOptions,
hash_fn: HashFunction,
}
impl ProvingOptions {
// CONSTANTS
// --------------------------------------------------------------------------------------------
/// Standard proof parameters for 96-bit conjectured security in non-recursive context.
pub const REGULAR_96_BITS: WinterProofOptions =
WinterProofOptions::new(27, 8, 16, FieldExtension::Quadratic, 8, 255);
/// Standard proof parameters for 128-bit conjectured security in non-recursive context.
pub const REGULAR_128_BITS: WinterProofOptions =
WinterProofOptions::new(27, 16, 21, FieldExtension::Cubic, 8, 255);
/// Standard proof parameters for 96-bit conjectured security in recursive context.
pub const RECURSIVE_96_BITS: WinterProofOptions =
WinterProofOptions::new(27, 8, 16, FieldExtension::Quadratic, 4, 7);
/// Standard proof parameters for 128-bit conjectured security in recursive context.
pub const RECURSIVE_128_BITS: WinterProofOptions =
WinterProofOptions::new(27, 16, 21, FieldExtension::Cubic, 4, 7);
// CONSTRUCTORS
// --------------------------------------------------------------------------------------------
/// Creates a new instance of [ProvingOptions] from the specified parameters.
pub fn new(
num_queries: usize,
blowup_factor: usize,
grinding_factor: u32,
field_extension: FieldExtension,
fri_folding_factor: usize,
fri_remainder_max_degree: usize,
hash_fn: HashFunction,
) -> Self {
let proof_options = WinterProofOptions::new(
num_queries,
blowup_factor,
grinding_factor,
field_extension,
fri_folding_factor,
fri_remainder_max_degree,
);
let exec_options = ExecutionOptions::default();
Self { exec_options, proof_options, hash_fn }
}
/// Creates a new preset instance of [ProvingOptions] targeting 96-bit security level.
///
/// If `recursive` flag is set to true, proofs will be generated using an arithmetization-
/// friendly hash function (RPO). Such proofs are well-suited for recursive proof verification,
/// but may take significantly longer to generate.
pub fn with_96_bit_security(recursive: bool) -> Self {
if recursive {
Self {
exec_options: ExecutionOptions::default(),
proof_options: Self::RECURSIVE_96_BITS,
hash_fn: HashFunction::Rpo256,
}
} else {
Self {
exec_options: ExecutionOptions::default(),
proof_options: Self::REGULAR_96_BITS,
hash_fn: HashFunction::Blake3_192,
}
}
}
/// Creates a new preset instance of [ProvingOptions] targeting 96-bit security level,
/// using the RPX hashing function.
pub fn with_96_bit_security_rpx() -> Self {
Self {
exec_options: ExecutionOptions::default(),
proof_options: Self::RECURSIVE_96_BITS,
hash_fn: HashFunction::Rpx256,
}
}
/// Creates a new preset instance of [ProvingOptions] targeting 128-bit security level.
///
/// If `recursive` flag is set to true, proofs will be generated using an arithmetization-
/// friendly hash function (RPO). Such proofs are well-suited for recursive proof verification,
/// but may take significantly longer to generate.
pub fn with_128_bit_security(recursive: bool) -> Self {
if recursive {
Self {
exec_options: ExecutionOptions::default(),
proof_options: Self::RECURSIVE_128_BITS,
hash_fn: HashFunction::Rpo256,
}
} else {
Self {
exec_options: ExecutionOptions::default(),
proof_options: Self::REGULAR_128_BITS,
hash_fn: HashFunction::Blake3_256,
}
}
}
/// Creates a new preset instance of [ProvingOptions] targeting 128-bit security level,
/// using the RPX hashing function.
pub fn with_128_bit_security_rpx() -> Self {
Self {
exec_options: ExecutionOptions::default(),
proof_options: Self::RECURSIVE_128_BITS,
hash_fn: HashFunction::Rpx256,
}
}
/// Sets [ExecutionOptions] for this [ProvingOptions].
///
/// This sets the maximum number of cycles a program is allowed to execute as well as
/// the number of cycles the program is expected to execute.
pub fn with_execution_options(mut self, exec_options: ExecutionOptions) -> Self {
self.exec_options = exec_options;
self
}
// PUBLIC ACCESSORS
// --------------------------------------------------------------------------------------------
/// Returns the hash function to be used in STARK proof generation.
pub const fn hash_fn(&self) -> HashFunction {
self.hash_fn
}
/// Returns the execution options specified for this [ProvingOptions]
pub const fn execution_options(&self) -> &ExecutionOptions {
&self.exec_options
}
}
impl Default for ProvingOptions {
fn default() -> Self {
Self::with_96_bit_security(false)
}
}
impl From<ProvingOptions> for WinterProofOptions {
fn from(options: ProvingOptions) -> Self {
options.proof_options
}
}
// EXECUTION OPTIONS
// ================================================================================================
/// A set of parameters specifying execution parameters of the VM.
///
/// - `max_cycles` specifies the maximum number of cycles a program is allowed to execute.
/// - `expected_cycles` specifies the number of cycles a program is expected to execute.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ExecutionOptions {
max_cycles: u32,
expected_cycles: u32,
enable_tracing: bool,
enable_debugging: bool,
}
impl Default for ExecutionOptions {
fn default() -> Self {
ExecutionOptions {
max_cycles: u32::MAX,
expected_cycles: MIN_TRACE_LEN as u32,
enable_tracing: false,
enable_debugging: false,
}
}
}
impl ExecutionOptions {
// CONSTRUCTOR
// --------------------------------------------------------------------------------------------
/// Creates a new instance of [ExecutionOptions] from the specified parameters.
///
/// If the `max_cycles` is `None` the maximum number of cycles will be set to `u32::MAX`
pub fn new(
max_cycles: Option<u32>,
expected_cycles: u32,
enable_tracing: bool,
) -> Result<Self, ExecutionOptionsError> {
let max_cycles = max_cycles.unwrap_or(u32::MAX);
if max_cycles < MIN_TRACE_LEN as u32 {
return Err(ExecutionOptionsError::MaxCycleNumTooSmall(expected_cycles));
}
if max_cycles < expected_cycles {
return Err(ExecutionOptionsError::ExpectedCyclesTooBig(max_cycles, expected_cycles));
}
// Round up the expected number of cycles to the next power of two. If it is smaller than
// MIN_TRACE_LEN -- pad expected number to it.
let expected_cycles = expected_cycles.next_power_of_two().max(MIN_TRACE_LEN as u32);
Ok(ExecutionOptions {
max_cycles,
expected_cycles,
enable_tracing,
enable_debugging: false,
})
}
/// Enables execution of the `trace` instructions.
pub fn with_tracing(mut self) -> Self {
self.enable_tracing = true;
self
}
/// Enables execution of programs in debug mode.
///
/// In debug mode the VM does the following:
/// - Executes `debug` instructions (these are ignored in regular mode).
/// - Records additional info about program execution (e.g., keeps track of stack state at every
/// cycle of the VM) which enables stepping through the program forward and backward.
pub fn with_debugging(mut self) -> Self {
self.enable_debugging = true;
self
}
// PUBLIC ACCESSORS
// --------------------------------------------------------------------------------------------
/// Returns maximum number of cycles a program is allowed to execute for.
pub fn max_cycles(&self) -> u32 {
self.max_cycles
}
/// Returns the number of cycles a program is expected to take.
///
/// This will serve as a hint to the VM for how much memory to allocate for a program's
/// execution trace and may result in performance improvements when the number of expected
/// cycles is equal to the number of actual cycles.
pub fn expected_cycles(&self) -> u32 {
self.expected_cycles
}
/// Returns a flag indicating whether the VM should execute `trace` instructions.
pub fn enable_tracing(&self) -> bool {
self.enable_tracing
}
/// Returns a flag indicating whether the VM should execute a program in debug mode.
pub fn enable_debugging(&self) -> bool {
self.enable_debugging
}
}