Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

switch PERCENTAGE_MULTIPLIER from 2**24 to 10**6 to improve readability #77

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

switch PERCENTAGE_MULTIPLIER from 2**24 to 10**6 to improve readability #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion contracts/examples/AyiiProduct.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ contract AyiiProduct is

bytes32 public constant INSURER_ROLE = keccak256("INSURER");

uint256 public constant PERCENTAGE_MULTIPLIER = 2**24;
uint256 public constant PERCENTAGE_MULTIPLIER = 10**6;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a breaking change? This will have impact on all contracts stored on the blockchain as they now contain wrong values, correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, you're correct this is a breaking change. unless we would migrate the existing data.
probably bad idea to do this during a season

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could be handled by defining that we do not merge develop into mine while the season is running
needs to be properly discussed

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets discuss it when you're back.


uint256 public constant AAAY_MIN = 0;
uint256 public constant AAAY_MAX = 15;
Expand Down
49 changes: 26 additions & 23 deletions tests/test_ayii_product.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -571,34 +571,37 @@ def test_payout_percentage_calculation(gifAyiiProduct: GifAyiiProduct):
trigger = 0.75
exit = 0.1

# acceptable error margin
epsilon = 1e-06

# random example values
# expected payout = 0.091093117, aph = 1.9, aaay = 1.3
assert get_payout_delta(0.091093117, 1.9, 1.3, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0.091093117, 1.9, 1.3, tsi, trigger, exit, product, multiplier) < epsilon

# run through product example table
# harvest ratio >= trigger (75%) give 0 payout
assert get_payout_delta(0, 100.0, 110.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0, 100.0, 100.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0, 100.0, 95.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0, 100.0, 90.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0, 100.0, 85.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0, 100.0, 80.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0, 100.0, 75.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0.06923073, 100.0, 70.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0.13846153, 100.0, 65.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0.20769232, 100.0, 60.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0.27692312, 100.0, 55.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0.34615379, 100.0, 50.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0.41538459, 100.0, 45.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0.48461532, 100.0, 40.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0.55384612, 100.0, 35.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0.62307691, 100.0, 30.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0.69230759, 100.0, 25.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0.76153838, 100.0, 20.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0.83076918, 100.0, 15.0, tsi, trigger, exit, product, multiplier) < 0.00000001
assert get_payout_delta(0.9, 100.0, 10.0, tsi, trigger, exit, product, multiplier) < 0.0000001
assert get_payout_delta(0.9, 100.0, 5.0, tsi, trigger, exit, product, multiplier) < 0.0000001
assert get_payout_delta(0.9, 100.0, 0.0, tsi, trigger, exit, product, multiplier) < 0.0000001
assert get_payout_delta(0, 100.0, 110.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0, 100.0, 100.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0, 100.0, 95.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0, 100.0, 90.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0, 100.0, 85.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0, 100.0, 80.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0, 100.0, 75.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0.06923073, 100.0, 70.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0.13846153, 100.0, 65.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0.20769232, 100.0, 60.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0.27692312, 100.0, 55.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0.34615379, 100.0, 50.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0.41538459, 100.0, 45.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0.48461532, 100.0, 40.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0.55384612, 100.0, 35.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0.62307691, 100.0, 30.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0.69230759, 100.0, 25.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0.76153838, 100.0, 20.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0.83076918, 100.0, 15.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0.9, 100.0, 10.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0.9, 100.0, 5.0, tsi, trigger, exit, product, multiplier) < epsilon
assert get_payout_delta(0.9, 100.0, 0.0, tsi, trigger, exit, product, multiplier) < epsilon


def test_payout_percentage_calculation_single(gifAyiiProduct: GifAyiiProduct):
Expand Down