Add `EXCESS_BALANCE` hint #1777

fmoletta · 2024-05-28T21:31:36Z

Implements hint:

%{
            from excess_balance import excess_balance_func

            res = excess_balance_func(ids, memory, __dict_manager)

            ids.check_account_value = res["account_value"]
            ids.check_excess_balance = res["excess_balance"]
            ids.check_margin_requirement_d = res["margin_requirement"]
            ids.check_unrealized_pnl_d = res["unrealized_pnl"]
%}

github-actions · 2024-05-28T21:41:56Z

**Hyper Thereading Benchmark results**




hyperfine -r 2 -n "hyper_threading_main threads: 1" 'RAYON_NUM_THREADS=1 ./hyper_threading_main' -n "hyper_threading_pr threads: 1" 'RAYON_NUM_THREADS=1 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 1
  Time (mean ± σ):     26.971 s ±  0.047 s    [User: 26.136 s, System: 0.834 s]
  Range (min … max):   26.938 s … 27.005 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 1
  Time (mean ± σ):     25.208 s ±  0.041 s    [User: 24.474 s, System: 0.732 s]
  Range (min … max):   25.179 s … 25.237 s    2 runs
 
Summary
  'hyper_threading_pr threads: 1' ran
    1.07 ± 0.00 times faster than 'hyper_threading_main threads: 1'




hyperfine -r 2 -n "hyper_threading_main threads: 2" 'RAYON_NUM_THREADS=2 ./hyper_threading_main' -n "hyper_threading_pr threads: 2" 'RAYON_NUM_THREADS=2 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 2
  Time (mean ± σ):     15.076 s ±  0.033 s    [User: 26.921 s, System: 0.778 s]
  Range (min … max):   15.052 s … 15.099 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 2
  Time (mean ± σ):     14.185 s ±  0.012 s    [User: 25.306 s, System: 0.768 s]
  Range (min … max):   14.176 s … 14.193 s    2 runs
 
Summary
  'hyper_threading_pr threads: 2' ran
    1.06 ± 0.00 times faster than 'hyper_threading_main threads: 2'




hyperfine -r 2 -n "hyper_threading_main threads: 4" 'RAYON_NUM_THREADS=4 ./hyper_threading_main' -n "hyper_threading_pr threads: 4" 'RAYON_NUM_THREADS=4 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 4
  Time (mean ± σ):     11.161 s ±  0.169 s    [User: 38.188 s, System: 0.983 s]
  Range (min … max):   11.041 s … 11.280 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 4
  Time (mean ± σ):     10.435 s ±  0.288 s    [User: 37.480 s, System: 0.975 s]
  Range (min … max):   10.232 s … 10.639 s    2 runs
 
Summary
  'hyper_threading_pr threads: 4' ran
    1.07 ± 0.03 times faster than 'hyper_threading_main threads: 4'




hyperfine -r 2 -n "hyper_threading_main threads: 6" 'RAYON_NUM_THREADS=6 ./hyper_threading_main' -n "hyper_threading_pr threads: 6" 'RAYON_NUM_THREADS=6 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 6
  Time (mean ± σ):     10.581 s ±  0.194 s    [User: 38.179 s, System: 1.079 s]
  Range (min … max):   10.444 s … 10.719 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 6
  Time (mean ± σ):     10.137 s ±  0.164 s    [User: 37.388 s, System: 0.978 s]
  Range (min … max):   10.021 s … 10.253 s    2 runs
 
Summary
  'hyper_threading_pr threads: 6' ran
    1.04 ± 0.03 times faster than 'hyper_threading_main threads: 6'




hyperfine -r 2 -n "hyper_threading_main threads: 8" 'RAYON_NUM_THREADS=8 ./hyper_threading_main' -n "hyper_threading_pr threads: 8" 'RAYON_NUM_THREADS=8 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 8
  Time (mean ± σ):     10.612 s ±  0.002 s    [User: 38.541 s, System: 1.091 s]
  Range (min … max):   10.610 s … 10.613 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 8
  Time (mean ± σ):     10.274 s ±  0.111 s    [User: 37.469 s, System: 0.985 s]
  Range (min … max):   10.196 s … 10.352 s    2 runs
 
Summary
  'hyper_threading_pr threads: 8' ran
    1.03 ± 0.01 times faster than 'hyper_threading_main threads: 8'




hyperfine -r 2 -n "hyper_threading_main threads: 16" 'RAYON_NUM_THREADS=16 ./hyper_threading_main' -n "hyper_threading_pr threads: 16" 'RAYON_NUM_THREADS=16 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 16
  Time (mean ± σ):     10.426 s ±  0.142 s    [User: 38.994 s, System: 1.121 s]
  Range (min … max):   10.325 s … 10.526 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 16
  Time (mean ± σ):      9.996 s ±  0.010 s    [User: 37.866 s, System: 1.058 s]
  Range (min … max):    9.989 s … 10.003 s    2 runs
 
Summary
  'hyper_threading_pr threads: 16' ran
    1.04 ± 0.01 times faster than 'hyper_threading_main threads: 16'

github-actions · 2024-05-28T21:56:24Z

Benchmark Results for unmodified programs 🚀

Command	Mean [s]	Min [s]	Max [s]	Relative
`base big_factorial`	2.156 ± 0.082	2.104	2.379	1.08 ± 0.04
`head big_factorial`	1.998 ± 0.016	1.980	2.025	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
`base big_fibonacci`	2.055 ± 0.013	2.035	2.073	1.05 ± 0.01
`head big_fibonacci`	1.958 ± 0.009	1.941	1.969	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
`base blake2s_integration_benchmark`	7.852 ± 0.156	7.675	8.103	1.06 ± 0.02
`head blake2s_integration_benchmark`	7.402 ± 0.091	7.302	7.555	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
`base compare_arrays_200000`	2.193 ± 0.018	2.157	2.211	1.05 ± 0.02
`head compare_arrays_200000`	2.087 ± 0.044	2.063	2.210	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
`base dict_integration_benchmark`	1.444 ± 0.016	1.430	1.484	1.04 ± 0.01
`head dict_integration_benchmark`	1.384 ± 0.009	1.373	1.401	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
`base field_arithmetic_get_square_benchmark`	1.262 ± 0.051	1.223	1.401	1.05 ± 0.04
`head field_arithmetic_get_square_benchmark`	1.202 ± 0.015	1.183	1.225	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
`base integration_builtins`	7.853 ± 0.140	7.655	8.044	1.05 ± 0.02
`head integration_builtins`	7.446 ± 0.104	7.355	7.677	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
`base keccak_integration_benchmark`	8.270 ± 0.332	7.951	8.917	1.07 ± 0.04
`head keccak_integration_benchmark`	7.717 ± 0.090	7.582	7.847	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
`base linear_search`	2.153 ± 0.014	2.138	2.182	1.06 ± 0.01
`head linear_search`	2.040 ± 0.015	2.028	2.077	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
`base math_cmp_and_pow_integration_benchmark`	1.490 ± 0.011	1.474	1.507	1.04 ± 0.02
`head math_cmp_and_pow_integration_benchmark`	1.436 ± 0.022	1.420	1.498	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
`base math_integration_benchmark`	1.479 ± 0.016	1.465	1.521	1.03 ± 0.01
`head math_integration_benchmark`	1.430 ± 0.009	1.413	1.441	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
`base memory_integration_benchmark`	1.237 ± 0.030	1.217	1.320	1.06 ± 0.03
`head memory_integration_benchmark`	1.168 ± 0.006	1.158	1.177	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
`base operations_with_data_structures_benchmarks`	1.567 ± 0.006	1.558	1.576	1.04 ± 0.01
`head operations_with_data_structures_benchmarks`	1.507 ± 0.008	1.496	1.522	1.00

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`base pedersen`	524.0 ± 1.8	521.4	527.1	1.02 ± 0.00
`head pedersen`	511.8 ± 1.4	509.9	514.0	1.00

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`base poseidon_integration_benchmark`	767.2 ± 7.1	760.3	783.8	1.03 ± 0.01
`head poseidon_integration_benchmark`	744.4 ± 3.4	740.5	752.5	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
`base secp_integration_benchmark`	1.845 ± 0.011	1.827	1.862	1.03 ± 0.01
`head secp_integration_benchmark`	1.788 ± 0.006	1.779	1.797	1.00

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`base set_integration_benchmark`	682.7 ± 15.1	671.9	714.5	1.04 ± 0.02
`head set_integration_benchmark`	657.5 ± 2.2	654.6	661.5	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
`base uint256_integration_benchmark`	4.431 ± 0.123	4.331	4.752	1.07 ± 0.03
`head uint256_integration_benchmark`	4.155 ± 0.021	4.122	4.185	1.00

codecov · 2024-05-29T18:53:49Z

Codecov Report

Attention: Patch coverage is 97.79338% with 22 lines in your changes are missing coverage. Please review.

Project coverage is 94.84%. Comparing base (c745ece) to head (b7af6b5).

Files	Patch %	Lines
...processor/builtin_hint_processor/excess_balance.rs	98.67%	13 Missing ⚠️
...int_processor/builtin_hint_processor_definition.rs	14.28%	6 Missing ⚠️
...t_processor/builtin_hint_processor/dict_manager.rs	57.14%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1777      +/-   ##
==========================================
+ Coverage   94.77%   94.84%   +0.07%     
==========================================
  Files         101      102       +1     
  Lines       39056    40053     +997     
==========================================
+ Hits        37015    37990     +975     
- Misses       2041     2063      +22

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

juanbono · 2024-05-29T20:50:12Z

vm/src/hint_processor/builtin_hint_processor/excess_balance.rs

+
+    // Apply data type conversions
+    let apply_conversion =
+        |k: &MaybeRelocatable, v: &MaybeRelocatable| -> Option<(String, Decimal)> {


…cairo-vm into excess-balance-hint

pefontana

LGTM!

sv · 2024-05-31T05:26:51Z

vm/src/vm/errors/hint_errors.rs

@@ -184,6 +184,12 @@ pub enum HintError {
    NPairBitsTooLowM,
    #[error("{0}")]
    SyscallError(Box<str>),
+    #[error("excess_balance_func: Failed to fetch {0} dictionary. It is either missing or has unexpected data types")]
+    ExcessBalanceFailedToFecthDict(Box<str>),


ExcessBalanceFailedToFecthDict -> ExcessBalanceFailedToFetchDict

Small typo in Fetch

* 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

* 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]>

fmoletta added 22 commits May 23, 2024 18:08

WIP

e0311c2

Add MarginParams

e6e0426

Impl imf

fc9dbca

Start excess_balance fn

a892bc1

Add TODO comment

13b042f

refactor + handle errors

5960a2b

Remove unused error

f47b980

Finish implementing hint

8f84fd5

Handle error

1f473f8

Fix var names

c2b12de

Setup hint test

223d0b4

Fix test

a613ca4

Fix test

a278e53

Fix test

4a3d376

Fix test values

189baf8

Fix

6bfceff

Update

3675270

Fix

97774b8

Use constants

c835e15

Remove unwrap

47eacd5

Remove allow

484f549

Remove unused feature

3ea1121

fmoletta added 5 commits May 28, 2024 19:03

Add failure test case

c696e66

Fix test values

a2e795e

Add no-std imports

846042c

Add no-std imports

5ba7eb8

Add hint code

4f40f70

fmoletta changed the title ~~[WIP] Excess balance hint~~ Add EXCESS_BALANCE hint May 29, 2024

fmoletta and others added 2 commits May 29, 2024 15:32

Add changelog entry

991e5c1

Merge branch 'main' into excess-balance-hint

d5ebdec

fmoletta marked this pull request as ready for review May 29, 2024 18:38

fmoletta requested review from igaray, Oppen, juanbono and pefontana as code owners May 29, 2024 18:38

juanbono reviewed May 29, 2024

View reviewed changes

fmoletta and others added 3 commits May 29, 2024 19:19

Use checked arithmetic operations

26120c6

Merge branch 'excess-balance-hint' of https://github.com/lambdaclass/…

48dcbd3

…cairo-vm into excess-balance-hint

Merge branch 'main' into excess-balance-hint

ff667db

juanbono approved these changes May 30, 2024

View reviewed changes

Merge branch 'main' into excess-balance-hint

b7af6b5

pefontana approved these changes May 30, 2024

View reviewed changes

pefontana enabled auto-merge May 30, 2024 19:34

pefontana added this pull request to the merge queue May 30, 2024

Merged via the queue into main with commit c65591e May 30, 2024
72 checks passed

pefontana deleted the excess-balance-hint branch May 30, 2024 19:55

sv reviewed May 31, 2024

View reviewed changes

fmoletta mentioned this pull request Jun 6, 2024

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

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `EXCESS_BALANCE` hint #1777

Add `EXCESS_BALANCE` hint #1777

fmoletta commented May 28, 2024 •

edited

Loading

github-actions bot commented May 28, 2024 •

edited

Loading

github-actions bot commented May 28, 2024 •

edited

Loading

codecov bot commented May 29, 2024 •

edited

Loading

juanbono May 29, 2024

pefontana left a comment

sv May 31, 2024

Add EXCESS_BALANCE hint #1777

Add EXCESS_BALANCE hint #1777

Conversation

fmoletta commented May 28, 2024 • edited Loading

github-actions bot commented May 28, 2024 • edited Loading

github-actions bot commented May 28, 2024 • edited Loading

codecov bot commented May 29, 2024 • edited Loading

Codecov Report

juanbono May 29, 2024

Choose a reason for hiding this comment

pefontana left a comment

Choose a reason for hiding this comment

sv May 31, 2024

Choose a reason for hiding this comment

Add `EXCESS_BALANCE` hint #1777

Add `EXCESS_BALANCE` hint #1777

fmoletta commented May 28, 2024 •

edited

Loading

github-actions bot commented May 28, 2024 •

edited

Loading

github-actions bot commented May 28, 2024 •

edited

Loading

codecov bot commented May 29, 2024 •

edited

Loading