Add EXCESS_BALANCE hint & Bump Rust to 1.74 (base 0.9.x) (#1786)

* 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 * lock flamegraph dep * Lock more dependencies * fix * Lock more dependencies * Update Rust version to 1.74.1 (#1605) * Update rust version to 1.74.1 * cargo fmt -all * Update Makefile * cargo clippy --fix * fix cargo clippy * restore fuzzer/Cargo.lock --------- Co-authored-by: Pedro Fontana <[email protected]> * Apply clippy * fmt * Remove cairo1-run * Revert "Remove cairo1-run" This reverts commit ef5d214. * Remove changes to cairo1-run crate --------- Co-authored-by: Pedro Fontana <[email protected]> Co-authored-by: Pedro Fontana <[email protected]>
lambdaclass · Jun 7, 2024 · 3d00941 · 3d00941
1 parent 8ab4471
commit 3d00941
Show file tree

Hide file tree

Showing 27 changed files with 1,307 additions and 40 deletions.
diff --git a/.github/workflows/bench.yml b/.github/workflows/bench.yml
@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
     - name: Install Rust
-      uses: dtolnay/rust-toolchain@1.70.0
+      uses: dtolnay/rust-toolchain@1.74.1
       with:
           components: rustfmt, clippy
     - uses: actions/checkout@v3

diff --git a/.github/workflows/cairo_1_programs.yml b/.github/workflows/cairo_1_programs.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: Install Rust toolchain
-        uses: dtolnay/rust-toolchain@1.70.0
+        uses: dtolnay/rust-toolchain@1.74.1
       - name: Set up Cargo cache
         uses: Swatinem/rust-cache@v2
       - name: Checkout

diff --git a/.github/workflows/fresh_run.yml b/.github/workflows/fresh_run.yml
@@ -35,7 +35,7 @@ jobs:
       uses: actions/checkout@v3
 
     - name: Install Rust
-      uses: dtolnay/rust-toolchain@1.70.0
+      uses: dtolnay/rust-toolchain@1.74.1
 
     - name: Install Pyenv
       uses: "gabrielfalcao/pyenv-action@v13"

diff --git a/.github/workflows/hint_accountant.yml b/.github/workflows/hint_accountant.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - name: Install Rust toolchain
-      uses: dtolnay/rust-toolchain@1.70.0
+      uses: dtolnay/rust-toolchain@1.74.1
     - name: Set up Cargo cache
       uses: Swatinem/rust-cache@v2
     - name: Checkout

diff --git a/.github/workflows/hyperfine.yml b/.github/workflows/hyperfine.yml
@@ -74,7 +74,7 @@ jobs:
 
       - name: Install Rust
         if: ${{ steps.cache.outputs.cache-hit != 'true' }}
-        uses: dtolnay/rust-toolchain@1.70.0
+        uses: dtolnay/rust-toolchain@1.74.1
 
       - name: Checkout
         if: ${{ steps.cache.outputs.cache-hit != 'true' }}

diff --git a/.github/workflows/iai_main.yml b/.github/workflows/iai_main.yml
@@ -11,7 +11,7 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v3
     - name: Install Rust
-      uses: dtolnay/rust-toolchain@1.70.0
+      uses: dtolnay/rust-toolchain@1.74.1
     - name: Set up cargo cache
       uses: Swatinem/rust-cache@v2
     - name: Python3 Build

diff --git a/.github/workflows/iai_pr.yml b/.github/workflows/iai_pr.yml
@@ -23,7 +23,7 @@ jobs:
 
     - name: Install Rust
       if: ${{ steps.cache-iai-results.outputs.cache-hit != 'true' }}
-      uses: dtolnay/rust-toolchain@1.70.0
+      uses: dtolnay/rust-toolchain@1.74.1
     - name: Set up cargo cache
       if: ${{ steps.cache-iai-results.outputs.cache-hit != 'true' }}
       uses: Swatinem/rust-cache@v2
@@ -51,7 +51,7 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v3
     - name: Install Rust
-      uses: dtolnay/rust-toolchain@1.70.0
+      uses: dtolnay/rust-toolchain@1.74.1
     - name: Set up cargo cache
       uses: Swatinem/rust-cache@v2
     - name: Python3 Build

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -13,15 +13,7 @@ jobs:
     - name: Checkout sources
       uses: actions/checkout@v2
     - name: Install stable toolchain
-      uses: dtolnay/[email protected]
-    - name: Publish crate cairo-felt
-      env:
-          CRATES_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
-      run: cargo publish --token ${CRATES_TOKEN} --all-features --manifest-path ./felt/Cargo.toml
-    # FIXME: there should be a better way to make sure the index in crates.io is updated before publishing
-    # cairo-vm but right now the step throws timeout and fails. 
-    - name: wait for index in crates.io
-      run: sleep 300
+      uses: dtolnay/[email protected]
     - name: Publish crate cairo-vm
       env:
           CRATES_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}

diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -129,7 +129,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - name: Install Rust
-      uses: dtolnay/rust-toolchain@1.70.0
+      uses: dtolnay/rust-toolchain@1.74.1
       with:
           components: rustfmt, clippy
     - name: Set up cargo cache
@@ -159,7 +159,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - name: Install Rust
-      uses: dtolnay/rust-toolchain@1.70.0
+      uses: dtolnay/rust-toolchain@1.74.1
       with:
         targets: wasm32-unknown-unknown
 
@@ -220,7 +220,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - name: Install Rust
-      uses: dtolnay/rust-toolchain@1.70.0
+      uses: dtolnay/rust-toolchain@1.74.1
       with:
           components: llvm-tools-preview
     - name: Set up cargo cache
@@ -281,7 +281,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - name: Install Rust
-      uses: dtolnay/rust-toolchain@1.70.0
+      uses: dtolnay/rust-toolchain@1.74.1
     - name: Set up cargo cache
       uses: Swatinem/rust-cache@v2
     - name: Checkout

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/Makefile b/Makefile
@@ -177,11 +177,11 @@ build-cairo-2-compiler:
 cargo-deps:
 	cargo install --version 0.3.1 iai-callgrind-runner
 	cargo install --version 1.1.0 cargo-criterion
-	cargo install --version 0.6.1 flamegraph
+	cargo install --version 0.6.1 flamegraph --locked
 	cargo install --version 1.14.0 hyperfine
-	cargo install --version 0.9.49 cargo-nextest
-	cargo install --version 0.5.9 cargo-llvm-cov
-	cargo install --version 0.12.1 wasm-pack
+	cargo install --version 0.9.49 cargo-nextest --locked
+	cargo install --version 0.5.9 cargo-llvm-cov --locked
+	cargo install --version 0.12.1 wasm-pack --locked
 
 cairo1-run-deps:
 	cd cairo1-run; make deps

diff --git a/README.md b/README.md
@@ -72,7 +72,7 @@ It's Turing-complete and it was created by [Starkware](https://starkware.co/) as
 
 These are needed in order to compile and use the project.
 
-- [Rust 1.70.0 or newer](https://www.rust-lang.org/tools/install)
+- [Rust 1.74.1 or newer](https://www.rust-lang.org/tools/install)
 - Cargo
 
 #### Optional

diff --git a/felt/src/lib_bigint_felt.rs b/felt/src/lib_bigint_felt.rs
@@ -377,7 +377,7 @@ impl Add<&Felt252> for u64 {
         };
         // A single digit means this is effectively the sum of two `u64` numbers.
         let Some(h0) = rhs_digits.next() else {
-            return self.checked_add(low)
+            return self.checked_add(low);
         };
         // Now we need to compare the 3 most significant digits.
         // There are two relevant cases from now on, either `rhs` behaves like a

diff --git a/rust-toolchain b/rust-toolchain
@@ -1,4 +1,4 @@
 [toolchain]
-channel = "1.70.0"
+channel = "1.74.1"
 components = ["rustfmt", "clippy"]
 profile = "minimal"
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)