Add EXCESS_BALANCE hint (#1777)

* WIP * Add MarginParams * Impl imf * Start excess_balance fn * Add TODO comment * refactor + handle errors * Remove unused error * Finish implementing hint * Handle error * Fix var names * Setup hint test * Fix test * Fix test * Fix test * Fix test values * Fix * Update * Fix * Use constants * Remove unwrap * Remove allow * Remove unused feature * Add failure test case * Fix test values * Add no-std imports * Add no-std imports * Add hint code * Add changelog entry * Use checked arithmetic operations
lambdaclass · Jun 6, 2024 · dfe3a5a · dfe3a5a
1 parent 8ab4471
commit dfe3a5a
Show file tree

Hide file tree

Showing 9 changed files with 1,274 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 #### Upcoming Changes
 
+* feat: Add `EXCESS_BALANCE` hint [#1777](https://github.com/lambdaclass/cairo-vm/pull/1777)
+
 #### [0.9.2] - 2024-01-3
 
 * Change ec_op_impl() to use ProjectivePoint [#1534](https://github.com/lambdaclass/cairo-vm/pull/1534)

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/vm/Cargo.toml b/vm/Cargo.toml
@@ -58,6 +58,7 @@ keccak = { workspace = true }
 hashbrown = { workspace = true }
 anyhow = { workspace = true }
 thiserror-no-std = { workspace = true }
+rust_decimal = { version = "1.35.0", default-features = false }
 
 # only for std
 num-prime = { version = "0.4.3", features = ["big-int"], optional = true }

diff --git a/vm/src/hint_processor/builtin_hint_processor/builtin_hint_processor_definition.rs b/vm/src/hint_processor/builtin_hint_processor/builtin_hint_processor_definition.rs
@@ -4,6 +4,7 @@ use super::{
         ec_recover_divmod_n_packed, ec_recover_product_div_m, ec_recover_product_mod,
         ec_recover_sub_a_b,
     },
+    excess_balance::excess_balance_hint,
     field_arithmetic::{u256_get_square_root, u384_get_square_root, uint384_div},
     secp::{
         ec_utils::{
@@ -815,6 +816,13 @@ impl HintProcessorLogic for BuiltinHintProcessor {
             hint_code::SPLIT_XX => split_xx(vm, &hint_data.ids_data, &hint_data.ap_tracking),
             #[cfg(feature = "skip_next_instruction_hint")]
             hint_code::SKIP_NEXT_INSTRUCTION => skip_next_instruction(vm),
+            hint_code::EXCESS_BALANCE => excess_balance_hint(
+                vm,
+                &hint_data.ids_data,
+                &hint_data.ap_tracking,
+                constants,
+                exec_scopes,
+            ),
             code => Err(HintError::UnknownHint(code.to_string().into_boxed_str())),
         }
     }

diff --git a/vm/src/hint_processor/builtin_hint_processor/dict_manager.rs b/vm/src/hint_processor/builtin_hint_processor/dict_manager.rs
@@ -191,6 +191,17 @@ impl DictTracker {
         }
     }
 
+    //Returns a reference to the contained dictionary, losing the dictionary type in the process
+    pub fn get_dictionary_ref(&self) -> &HashMap<MaybeRelocatable, MaybeRelocatable> {
+        match &self.data {
+            Dictionary::SimpleDictionary(dict) => dict,
+            Dictionary::DefaultDictionary {
+                dict,
+                default_value: _,
+            } => dict,
+        }
+    }
+
     pub fn get_value(&mut self, key: &MaybeRelocatable) -> Result<&MaybeRelocatable, HintError> {
         self.data
             .get(key)