Modify RunResources usage (#1241)

* Add RunResources.consume_steps && modify CairoRuner::run_until_pc and CairoRunner::run_from_entrypoint API

* Add RunResources as an input of HintProcessor::execute_hint

* fix test

* Add doc

* Modify field RunResources.n_steps: Option<usize>

* fix unit tests

* minor code refactors

* update changelog

* typo

Author: pefontana

CHANGELOG.md

@@ -6,6 +6,15 @@
 
 * fix(security): avoid denial of service on malicious input exploiting the scientific notation parser [#1239](https://github.com/lambdaclass/cairo-rs/pull/1239)
 
+* BREAKING: Change `RunResources` usage:
+    * Modify field type `RunResources.n_steps: Option<usize>,`
+    
+    * Public Api Changes:
+        *  CairoRunner::run_until_pc: Now receive a `&mut RunResources` instead of an `&mut Option<RunResources>`
+        *  CairoRunner::run_from_entrypoint: Now receive a `&mut RunResources` instead of an `&mut Option<RunResources>`
+        * VirtualMachine::Step: Add `&mut RunResources` as input
+        * Trait HintProcessor::execute_hint: Add  `&mut RunResources` as an input 
+
 * perf: accumulate `min` and `max` instruction offsets during run to speed up range check [#1080](https://github.com/lambdaclass/cairo-rs/pull/)
   BREAKING: `Cairo_runner::get_perm_range_check_limits` no longer returns an error when called without trace enabled, as it no longer depends on it
 

hint_accountant/src/main.rs

@@ -7,7 +7,10 @@ use cairo_vm::{
     },
     serde::deserialize_program::ApTracking,
     types::exec_scope::ExecutionScopes,
-    vm::{errors::hint_errors::HintError, vm_core::VirtualMachine},
+    vm::{
+        errors::hint_errors::HintError, runners::cairo_runner::RunResources,
+        vm_core::VirtualMachine,
+    },
     with_std::collections::{HashMap, HashSet},
 };
 use serde::Deserialize;
@@ -67,7 +70,13 @@ fn run() {
                 .compile_hint(h, &ap_tracking_data, &reference_ids, &references)
                 .expect("this implementation is infallible");
             matches!(
-                hint_executor.execute_hint(&mut vm, &mut exec_scopes, &hint_data, &constants),
+                hint_executor.execute_hint(
+                    &mut vm,
+                    &mut exec_scopes,
+                    &hint_data,
+                    &constants,
+                    &mut RunResources::default()
+                ),
                 Err(HintError::UnknownHint(_)),
             )
         })

vm/src/cairo_run.rs

@@ -3,7 +3,7 @@ use crate::{
     types::program::Program,
     vm::{
         errors::{cairo_run_errors::CairoRunError, vm_exception::VmException},
-        runners::cairo_runner::CairoRunner,
+        runners::cairo_runner::{CairoRunner, RunResources},
         security::verify_secure_runner,
         vm_core::VirtualMachine,
     },
@@ -59,7 +59,7 @@ pub fn cairo_run(
     let mut vm = VirtualMachine::new(cairo_run_config.trace_enabled);
     let end = cairo_runner.initialize(&mut vm)?;
     // check step calculation
-    let mut run_resources = None;
+    let mut run_resources = RunResources::default();
 
     cairo_runner
         .run_until_pc(end, &mut run_resources, &mut vm, hint_executor)
@@ -156,7 +156,7 @@ mod tests {
             .map_err(CairoRunError::Runner)?;
 
         assert!(cairo_runner
-            .run_until_pc(end, &mut None, &mut vm, hint_processor)
+            .run_until_pc(end, &mut RunResources::default(), &mut vm, hint_processor)
             .is_ok());
 
         Ok((cairo_runner, vm))
@@ -176,7 +176,12 @@ mod tests {
 
         let end = cairo_runner.initialize(&mut vm).unwrap();
         assert!(cairo_runner
-            .run_until_pc(end, &mut None, &mut vm, &mut hint_processor)
+            .run_until_pc(
+                end,
+                &mut RunResources::default(),
+                &mut vm,
+                &mut hint_processor
+            )
             .is_ok());
         assert!(cairo_runner.relocate(&mut vm, true).is_ok());
         // `main` returns without doing nothing, but `not_main` sets `[ap]` to `1`
@@ -296,7 +301,12 @@ mod tests {
         let mut vm = vm!();
         let end = cairo_runner.initialize(&mut vm).unwrap();
         assert!(cairo_runner
-            .run_until_pc(end, &mut None, &mut vm, &mut hint_processor)
+            .run_until_pc(
+                end,
+                &mut RunResources::default(),
+                &mut vm,
+                &mut hint_processor
+            )
             .is_ok());
         assert!(cairo_runner.relocate(&mut vm, false).is_ok());
         assert!(vm.get_relocated_trace().is_err());

vm/src/hint_processor/builtin_hint_processor/bigint.rs

@@ -105,6 +105,7 @@ mod test {
     use crate::stdlib::collections::HashMap;
     use crate::types::exec_scope::ExecutionScopes;
     use crate::utils::test_utils::*;
+    use crate::vm::runners::cairo_runner::RunResources;
     use crate::vm::vm_core::VirtualMachine;
     use assert_matches::assert_matches;
     use num_bigint::BigInt;

vm/src/hint_processor/builtin_hint_processor/blake2s_utils.rs

@@ -306,6 +306,7 @@ mod tests {
     use super::*;
     use crate::hint_processor::builtin_hint_processor::hint_code;
     use crate::types::errors::math_errors::MathError;
+    use crate::vm::runners::cairo_runner::RunResources;
     use crate::{
         any_box,
         hint_processor::{

vm/src/hint_processor/builtin_hint_processor/builtin_hint_processor_definition.rs

@@ -20,8 +20,11 @@ use super::{
         pack::*,
     },
 };
-use crate::hint_processor::builtin_hint_processor::secp::ec_utils::{
-    ec_double_assign_new_x, ec_double_assign_new_x_v2,
+use crate::{
+    hint_processor::builtin_hint_processor::secp::ec_utils::{
+        ec_double_assign_new_x, ec_double_assign_new_x_v2,
+    },
+    vm::runners::cairo_runner::RunResources,
 };
 use crate::{
     hint_processor::{
@@ -169,6 +172,7 @@ impl HintProcessor for BuiltinHintProcessor {
         exec_scopes: &mut ExecutionScopes,
         hint_data: &Box<dyn Any>,
         constants: &HashMap<String, Felt252>,
+        _run_resources: &mut RunResources,
     ) -> Result<(), HintError> {
         let hint_data = hint_data
             .downcast_ref::<HintProcessorData>()
@@ -807,6 +811,7 @@ mod tests {
     use crate::stdlib::any::Any;
     use crate::types::relocatable::Relocatable;
 
+    use crate::vm::runners::cairo_runner::RunResources;
     use crate::{
         any_box,
         hint_processor::hint_processor_definition::HintProcessor,
@@ -1222,7 +1227,8 @@ mod tests {
                 &mut vm,
                 exec_scopes,
                 &any_box!(hint_data),
-                &HashMap::new()
+                &HashMap::new(),
+                &mut RunResources::default(),
             ),
             Ok(())
         );
@@ -1234,7 +1240,8 @@ mod tests {
                 &mut vm,
                 exec_scopes,
                 &any_box!(hint_data),
-                &HashMap::new()
+                &HashMap::new(),
+                &mut RunResources::default(),
             ),
             Ok(())
         );

vm/src/hint_processor/builtin_hint_processor/cairo_keccak/keccak_hints.rs

@@ -368,6 +368,7 @@ pub fn u64_array_to_mayberelocatable_vec(array: &[u64]) -> Vec<MaybeRelocatable>
 mod tests {
     use super::*;
     use crate::stdlib::string::ToString;
+    use crate::vm::runners::cairo_runner::RunResources;
 
     use crate::{
         any_box,

vm/src/hint_processor/builtin_hint_processor/dict_hint_utils.rs

@@ -263,6 +263,7 @@ mod tests {
     use crate::stdlib::collections::HashMap;
     use crate::types::exec_scope::ExecutionScopes;
 
+    use crate::vm::runners::cairo_runner::RunResources;
     use crate::{
         hint_processor::builtin_hint_processor::dict_manager::{DictManager, DictTracker},
         relocatable,

vm/src/hint_processor/builtin_hint_processor/ec_recover.rs

@@ -118,6 +118,7 @@ mod tests {
     use crate::hint_processor::builtin_hint_processor::hint_code;
     use crate::hint_processor::hint_processor_definition::HintReference;
     use crate::utils::test_utils::*;
+    use crate::vm::runners::cairo_runner::RunResources;
     use crate::vm::vm_core::VirtualMachine;
     use crate::{
         any_box,

vm/src/hint_processor/builtin_hint_processor/ec_utils.rs

@@ -233,6 +233,7 @@ mod tests {
 
     use crate::hint_processor::builtin_hint_processor::hint_code;
     use crate::utils::test_utils::*;
+    use crate::vm::runners::cairo_runner::RunResources;
     use assert_matches::assert_matches;
 
     use super::*;