Add new error type HintError

CHANGELOG.md

@@ -20,4 +20,9 @@
 
 * Default implementation of compile_hint [#680](https://github.com/lambdaclass/cairo-rs/pull/680)
     * Internal changes: 
-        * Make the `compile_hint` implementation which was in the `BuiltinHintProcessor` the default implementation in the trait. 
+        * Make the `compile_hint` implementation which was in the `BuiltinHintProcessor` the default implementation in the trait. 
+
+* Add new error type `HintError` [#676](https://github.com/lambdaclass/cairo-rs/pull/676)
+    * Public Api changes:
+        * `HintProcessor::execute_hint()` now returns a `HintError` instead of a `VirtualMachineError`
+        * helper functions on `hint_processor_utils.rs` now return a `HintError`

custom_hint_example/src/main.rs

@@ -6,10 +6,11 @@ use cairo_rs::hint_processor::builtin_hint_processor::hint_utils::get_integer_fr
 use cairo_rs::hint_processor::hint_processor_definition::HintReference;
 use cairo_rs::types::exec_scope::ExecutionScopes;
 use cairo_rs::serde::deserialize_program::ApTracking;
-use cairo_rs::vm::{errors::vm_errors::VirtualMachineError, vm_core::VirtualMachine};
+use cairo_rs::vm::{errors::hint_errors::HintError, vm_core::VirtualMachine};
 use num_bigint::BigInt;
 use std::collections::HashMap;
 use std::path::Path;
+use std::rc::Rc;
 
 // Create the function that implements the custom hint
 fn print_a_hint(
@@ -18,7 +19,7 @@ fn print_a_hint(
     ids_data: &HashMap<String, HintReference>,
     ap_tracking: &ApTracking,
     _constants: &HashMap<String, BigInt>,
-) -> Result<(), VirtualMachineError> {
+) -> Result<(), HintError> {
     let a = get_integer_from_var_name("a", vm, ids_data, ap_tracking)?;
     println!("{}", a);
     Ok(())
@@ -32,14 +33,16 @@ fn main() {
     let mut hint_processor = BuiltinHintProcessor::new_empty();
 
     //Add the custom hint, together with the Python code
-    hint_processor.add_hint(String::from("print(ids.a)"), hint);
+    hint_processor.add_hint(String::from("print(ids.a)"), Rc::new(hint));
 
     //Run the cairo program
     cairo_run(
         Path::new("custom_hint.json"),
         "main",
         false,
         false,
+        "all",
+        false,
         &mut hint_processor,
     )
     .expect("Couldn't run program");

src/hint_processor/builtin_hint_processor/blake2s_utils.rs

@@ -6,6 +6,7 @@ use crate::hint_processor::builtin_hint_processor::hint_utils::{
 };
 use crate::hint_processor::hint_processor_definition::HintReference;
 use crate::hint_processor::hint_processor_utils::bigint_to_u32;
+use crate::vm::errors::hint_errors::HintError;
 use crate::vm::vm_core::VirtualMachine;
 use num_traits::ToPrimitive;
 use std::borrow::Cow;
@@ -18,14 +19,14 @@ use num_bigint::BigInt;
 
 fn get_fixed_size_u32_array<const T: usize>(
     h_range: &Vec<Cow<BigInt>>,
-) -> Result<[u32; T], VirtualMachineError> {
+) -> Result<[u32; T], HintError> {
     let mut u32_vec = Vec::<u32>::with_capacity(h_range.len());
     for num in h_range {
-        u32_vec.push(num.to_u32().ok_or(VirtualMachineError::BigintToU32Fail)?);
+        u32_vec.push(num.to_u32().ok_or(HintError::BigintToU32Fail)?);
     }
     u32_vec
         .try_into()
-        .map_err(|_| VirtualMachineError::FixedSizeArrayFail(T))
+        .map_err(|_| HintError::FixedSizeArrayFail(T))
 }
 
 fn get_maybe_relocatable_array_from_u32(array: &Vec<u32>) -> Vec<MaybeRelocatable> {
@@ -44,10 +45,7 @@ Computes the blake2s compress function and fills the value in the right position
 output_ptr should point to the middle of an instance, right after initial_state, message, t, f,
 which should all have a value at this point, and right before the output portion which will be
 written by this function.*/
-fn compute_blake2s_func(
-    vm: &mut VirtualMachine,
-    output_rel: Relocatable,
-) -> Result<(), VirtualMachineError> {
+fn compute_blake2s_func(vm: &mut VirtualMachine, output_rel: Relocatable) -> Result<(), HintError> {
     let h = get_fixed_size_u32_array::<8>(&vm.get_integer_range(&(output_rel.sub(26)?), 8)?)?;
     let message =
         get_fixed_size_u32_array::<16>(&vm.get_integer_range(&(output_rel.sub(18)?), 16)?)?;
@@ -69,7 +67,7 @@ pub fn compute_blake2s(
     vm: &mut VirtualMachine,
     ids_data: &HashMap<String, HintReference>,
     ap_tracking: &ApTracking,
-) -> Result<(), VirtualMachineError> {
+) -> Result<(), HintError> {
     let output = get_ptr_from_var_name("output", vm, ids_data, ap_tracking)?;
     compute_blake2s_func(vm, output)
 }
@@ -100,7 +98,7 @@ pub fn finalize_blake2s(
     vm: &mut VirtualMachine,
     ids_data: &HashMap<String, HintReference>,
     ap_tracking: &ApTracking,
-) -> Result<(), VirtualMachineError> {
+) -> Result<(), HintError> {
     const N_PACKED_INSTANCES: usize = 7;
     let blake2s_ptr_end = get_ptr_from_var_name("blake2s_ptr_end", vm, ids_data, ap_tracking)?;
     let message: [u32; 16] = [0; 16];
@@ -132,7 +130,7 @@ pub fn blake2s_add_uint256(
     vm: &mut VirtualMachine,
     ids_data: &HashMap<String, HintReference>,
     ap_tracking: &ApTracking,
-) -> Result<(), VirtualMachineError> {
+) -> Result<(), HintError> {
     //Get variables from ids
     let data_ptr = get_ptr_from_var_name("data", vm, ids_data, ap_tracking)?;
     let low_addr = get_relocatable_from_var_name("low", vm, ids_data, ap_tracking)?;
@@ -179,7 +177,7 @@ pub fn blake2s_add_uint256_bigend(
     vm: &mut VirtualMachine,
     ids_data: &HashMap<String, HintReference>,
     ap_tracking: &ApTracking,
-) -> Result<(), VirtualMachineError> {
+) -> Result<(), HintError> {
     //Get variables from ids
     let data_ptr = get_ptr_from_var_name("data", vm, ids_data, ap_tracking)?;
     let low_addr = get_relocatable_from_var_name("low", vm, ids_data, ap_tracking)?;
@@ -225,6 +223,7 @@ mod tests {
     use crate::relocatable;
     use crate::types::exec_scope::ExecutionScopes;
     use crate::utils::test_utils::*;
+    use crate::vm::errors::hint_errors::HintError;
     use crate::vm::vm_core::VirtualMachine;
     use crate::vm::vm_memory::memory::Memory;
     use crate::{bigint, vm::errors::memory_errors::MemoryError};
@@ -247,7 +246,9 @@ mod tests {
         //Execute the hint
         assert_eq!(
             run_hint!(vm, ids_data, hint_code),
-            Err(VirtualMachineError::CantSubOffset(5, 26))
+            Err(HintError::Internal(VirtualMachineError::CantSubOffset(
+                5, 26
+            )))
         );
     }
 
@@ -266,9 +267,9 @@ mod tests {
         //Execute the hint
         assert_eq!(
             run_hint!(vm, ids_data, hint_code),
-            Err(VirtualMachineError::ExpectedInteger(
+            Err(HintError::Internal(VirtualMachineError::ExpectedInteger(
                 MaybeRelocatable::from((2, 0))
-            ))
+            )))
         );
     }
 
@@ -286,8 +287,8 @@ mod tests {
         //Execute the hint
         assert_eq!(
             run_hint!(vm, ids_data, hint_code),
-            Err(VirtualMachineError::ExpectedRelocatable(
-                MaybeRelocatable::from((1, 0))
+            Err(HintError::Internal(
+                VirtualMachineError::ExpectedRelocatable(MaybeRelocatable::from((1, 0)))
             ))
         );
     }
@@ -316,7 +317,7 @@ mod tests {
         //Execute the hint
         assert_eq!(
             run_hint!(vm, ids_data, hint_code),
-            Err(VirtualMachineError::BigintToU32Fail)
+            Err(HintError::BigintToU32Fail)
         );
     }
 
@@ -334,9 +335,9 @@ mod tests {
         //Execute the hint
         assert_eq!(
             run_hint!(vm, ids_data, hint_code),
-            Err(VirtualMachineError::ExpectedInteger(
+            Err(HintError::Internal(VirtualMachineError::ExpectedInteger(
                 MaybeRelocatable::from((2, 0))
-            ))
+            )))
         );
     }
 
@@ -398,13 +399,13 @@ mod tests {
         //Execute the hint
         assert_eq!(
             run_hint!(vm, ids_data, hint_code),
-            Err(VirtualMachineError::MemoryError(
+            Err(HintError::Internal(VirtualMachineError::MemoryError(
                 MemoryError::InconsistentMemory(
                     MaybeRelocatable::from((2, 0)),
                     MaybeRelocatable::from((2, 0)),
                     MaybeRelocatable::from(bigint!(1795745351))
                 )
-            ))
+            )))
         );
     }
 
@@ -418,7 +419,7 @@ mod tests {
         //Execute the hint
         assert_eq!(
             run_hint!(vm, HashMap::new(), hint_code),
-            Err(VirtualMachineError::FailedToGetIds)
+            Err(HintError::FailedToGetIds)
         );
     }