Add new error type HintError

CHANGELOG.md

@@ -5,3 +5,21 @@
         * `pub fn get_location(pc: &usize, runner: &CairoRunner) -> Option<Location>` is now `pub fn get_location(pc: usize, runner: &CairoRunner) -> Option<Location>`
         * `pub fn decode_instruction(encoded_instr: i64, mut imm: Option<BigInt>) -> Result<instruction::Instruction, VirtualMachineError>` is now `pub fn decode_instruction(encoded_instr: i64, mut imm: Option<&BigInt>) -> Result<instruction::Instruction, VirtualMachineError>`
         * `VmExcepion` field's string format now mirror their cairo-lang conterparts.
+
+* Add input file contents to traceback [#666](https://github.com/lambdaclass/cairo-rs/pull/666/files)
+    * Public Api changes:
+        * `VirtualMachineError` enum variants containing `MaybeRelocatable` and/or `Relocatable` values now use the `Display` format instead of `Debug` in their `Display` implementation
+        * `get_traceback` now adds the source code line to each traceback entry
+
+* Use hint location instead of instruction location when building VmExceptions from hint failure [#673](https://github.com/lambdaclass/cairo-rs/pull/673/files)
+    * Public Api changes:
+        * `hints` field added to `InstructionLocation`
+        * `Program.instruction_locations` type changed from `Option<HashMap<usize, Location>>` to `Option<HashMap<usize, InstructionLocation>>`
+        * `VirtualMachineError`s produced by `HintProcessor::execute_hint()` will be wrapped in a `VirtualMachineError::Hint` error containing their hint_index
+        * `get_location()` now receives an an optional usize value `hint_index`, used to obtain hint locations
+
+* 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`
+

cairo_programs/bad_programs/bad_range_check.cairo

@@ -0,0 +1,25 @@
+%builtins range_check
+
+func check_range{range_check_ptr: felt*}(num: felt) {
+    with_attr error_message("Failed range-check") {
+        [range_check_ptr] = num;
+    }
+    return();
+}
+
+func sub_1_check_range{range_check_ptr: felt*}(num: felt) -> felt {
+    check_range(num - 1);
+    return num - 1;
+}
+
+func sub_by_1_check_range{range_check_ptr: felt*}(num: felt, sub_amount: felt) {
+    if (sub_amount == 0) {
+        return();
+    }
+    return sub_by_1_check_range(sub_1_check_range(num), sub_amount -1);
+}
+
+func main{range_check_ptr: felt*}() {
+    sub_by_1_check_range(6, 7);
+    return ();
+}

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");