Skip to content

Chore(evm) add combine pricefeed #2665

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

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

Chore(evm) add combine pricefeed #2665

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
24269ba
chore(evm) Add combine Pricefeeds
aditya520 May 8, 2025
cc4ed16
update
aditya520 May 8, 2025
b5d6299
update
aditya520 May 9, 2025
9952875
added some test
aditya520 May 9, 2025
eafc692
update
aditya520 May 9, 2025
b90ec8f
udpate
aditya520 May 9, 2025
e5525d2
fix
aditya520 May 12, 2025
af7b766
fix ci
aditya520 May 12, 2025
dd5f5a8
added custom errors
aditya520 May 13, 2025
dfe99e2
added math.sol
aditya520 May 13, 2025
2784001
update PythUtils
aditya520 May 14, 2025
8b6cf2d
wip-update
aditya520 May 14, 2025
2bbdb6e
update PythUtils
aditya520 May 15, 2025
84dc98c
removed argument
aditya520 May 15, 2025
90afd02
update
aditya520 May 28, 2025
9cffab1
chore(evm) Added support for positive expo in PythUtils
aditya520 Jun 13, 2025
c9cb235
chore(evm) Add combine pf
aditya520 Jun 13, 2025
c8ceba7
chore(evm) final edit convertToUnit
aditya520 Jun 18, 2025
dee0245
update
aditya520 Jun 18, 2025
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
177 changes: 167 additions & 10 deletions target_chains/ethereum/contracts/forge-test/utils/PythTestUtils.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,33 +370,190 @@ abstract contract PythTestUtils is Test, WormholeTestUtils, RandTestUtils {
}

contract PythUtilsTest is Test, WormholeTestUtils, PythTestUtils, IPythEvents {
function assertCrossRateEquals(
int64 price1,
int32 expo1,
int64 price2,
int32 expo2,
int32 targetExpo,
int256 expectedPrice
) internal {
int256 price = PythUtils.deriveCrossRate(price1, expo1, price2, expo2, targetExpo);
assertEq(price, expectedPrice);
}

function assertCrossRateReverts(
int64 price1,
int32 expo1,
int64 price2,
int32 expo2,
int32 targetExpo,
bytes4 expectedError
) internal {
vm.expectRevert(expectedError);
PythUtils.deriveCrossRate(price1, expo1, price2, expo2, targetExpo);
}

function testConvertToUnit() public {
// Price can't be negative
vm.expectRevert();

// Test 1: Price can't be negative
vm.expectRevert(PythErrors.NegativeInputPrice.selector);
PythUtils.convertToUint(-100, -5, 18);

// Exponent can't be positive
vm.expectRevert();
PythUtils.convertToUint(100, 5, 18);
// Test 2: Exponent can't be less than -255
vm.expectRevert(PythErrors.InvalidInputExpo.selector);
PythUtils.convertToUint(100, -256, 18);

// Test 3: This test will fail as the 10 ** 237 is too large for a uint256
vm.expectRevert(PythErrors.ExponentOverflow.selector);
assertEq(PythUtils.convertToUint(100, -255, 18), 0);

// Test 4: Combined Exponent can't be greater than 58 and less than -58
// See the calculation how we came up with 58 in PythUtils.sol
vm.expectRevert(PythErrors.ExponentOverflow.selector);
assertEq(PythUtils.convertToUint(100, 50, 9), 0); // 50 + 9 = 59 > 58
vm.expectRevert(PythErrors.ExponentOverflow.selector);
assertEq(PythUtils.convertToUint(100, -96, 37), 0); // -96 + 37 = -59 < -58

// Test 5: Negative Exponent Tests
// Price with 18 decimals and exponent -5
assertEq(
PythUtils.convertToUint(100, -5, 18),
1000000000000000 // 100 * 10^13
100_0_000_000_000_000 // 100 * 10^13
);

// Price with 9 decimals and exponent -2
assertEq(
PythUtils.convertToUint(100, -2, 9),
1000000000 // 100 * 10^7
100_0_000_000 // 100 * 10^7
);

// Price with 4 decimals and exponent -5
// Test 6: Price with 4 decimals and exponent -5
assertEq(PythUtils.convertToUint(100, -5, 4), 10);

// Price with 5 decimals and exponent -2
// Test 7: Price with 5 decimals and exponent -2
// @note: We will lose precision here as price is
// 0.00001 and we are targetDecimals is 2.
assertEq(PythUtils.convertToUint(100, -5, 2), 0);
assertEq(PythUtils.convertToUint(123, -8, 5), 0);

// Test 8: Positive Exponent Tests
// Price with 18 decimals and exponent 5
assertEq(PythUtils.convertToUint(100, 5, 18), 100_00_000_000_000_000_000_000_000); // 100 with 23 zeros
// Test 9: Price with 9 decimals and exponent 2
assertEq(PythUtils.convertToUint(100, 2, 9), 100_00_000_000_000); // 100 with 11 zeros

// Test 10: Price with 2 decimals and exponent 1
assertEq(PythUtils.convertToUint(100, 1, 2), 100_000); // 100 with 3 zeros


// Special Cases
// Test 11: price = 0, any expo/decimals returns 0
assertEq(PythUtils.convertToUint(0, -58, 0), 0);
assertEq(PythUtils.convertToUint(0, 0, 0), 0);
assertEq(PythUtils.convertToUint(0, 58, 0), 0);
assertEq(PythUtils.convertToUint(0, -58, 58), 0);

// Test 12: smallest positive price, maximum downward exponent (should round to zero)
assertEq(PythUtils.convertToUint(1, -58, 0), 0);
assertEq(PythUtils.convertToUint(1, -58, 58), 1);

// Test 13: deltaExponent == 0 (should be identical to price)
assertEq(PythUtils.convertToUint(123456, 0, 0), 123456);
assertEq(PythUtils.convertToUint(123456, -5, 5), 123456); // -5 + 5 == 0

// Test 14: deltaExponent > 0 (should shift price up)
assertEq(PythUtils.convertToUint(123456, 5, 0), 12345600000);
assertEq(PythUtils.convertToUint(123456, 5, 2), 1234560000000);

// Test 15: deltaExponent < 0 (should shift price down)
assertEq(PythUtils.convertToUint(123456, -5, 0), 1);
assertEq(PythUtils.convertToUint(123456, -5, 2), 123);

// Test 16: division with truncation
assertEq(PythUtils.convertToUint(999, -2, 0), 9); // 999/100 = 9 (truncated)
assertEq(PythUtils.convertToUint(199, -2, 0), 1); // 199/100 = 1 (truncated)
assertEq(PythUtils.convertToUint(99, -2, 0), 0); // 99/100 = 0 (truncated)

// Test 17: Big price and scaling, but outside of bounds
vm.expectRevert(PythErrors.ExponentOverflow.selector);
assertEq(PythUtils.convertToUint(100_000_000, 10, 50),0);

// Test 18: Big price and scaling
assertEq(PythUtils.convertToUint(100_000_000, -50, 10),0); // -50 + 10 = -40 > -58
vm.expectRevert(PythErrors.ExponentOverflow.selector);
assertEq(PythUtils.convertToUint(100_000_000, 10, 50), 0); // 10 + 50 = 60 > 58

// Test 19: Decimals just save from truncation
assertEq(PythUtils.convertToUint(5, -1, 1), 5); // 5/10*10 = 5
assertEq(PythUtils.convertToUint(5, -1, 2), 50); // 5/10*100 = 50

// 10. Test: Big price and scaling, should be inside the bounds
// We have to convert int64 -> int256 -> uint256 before multiplying by 10 ** 58
assertEq(PythUtils.convertToUint(type(int64).max, 50, 8), uint256(int256(type(int64).max)) * 10 ** 58); // 50 + 8 = 58
assertEq(PythUtils.convertToUint(type(int64).max, -64, 8), 0); // -64 + 8 = -56 > -58
assertEq(PythUtils.convertToUint(type(int64).max, -50, 1), 0); // -64 + 1 = -63 < -58

// 11. Test: Big price and scaling, should be inside the bounds
vm.expectRevert(PythErrors.ExponentOverflow.selector);
assertEq(PythUtils.convertToUint(type(int64).max, 50, 9), 0); // 50 + 9 = 59 > 58
vm.expectRevert(PythErrors.ExponentOverflow.selector);
assertEq(PythUtils.convertToUint(type(int64).max, -60, 1), 0); // -60 + 1 = -59 < -58

}

function testDeriveCrossRate() public {

// Test 1: Prices can't be negative
assertCrossRateReverts(-100, -2, 100, -2, 5, PythErrors.NegativeInputPrice.selector);
assertCrossRateReverts(100, -2, -100, -2, 5, PythErrors.NegativeInputPrice.selector);
assertCrossRateReverts(-100, -2, -100, -2, 5, PythErrors.NegativeInputPrice.selector);

// Test 2: Exponent can't be less than -255
assertCrossRateReverts(100, -256, 100, -2, 5, PythErrors.InvalidInputExpo.selector);
assertCrossRateReverts(100, -2, 100, -256, 5, PythErrors.InvalidInputExpo.selector);
assertCrossRateReverts(100, -256, 100, -256, 5, PythErrors.InvalidInputExpo.selector);

// Test 3: Basic Tests with negative exponents
assertCrossRateEquals(500, -8, 500, -8, -5, 100000);
assertCrossRateEquals(10_000, -8, 100, -2, -5, 10);
assertCrossRateEquals(10_000, -2, 100, -8, -5, 100_00_000_000_000);

// Test 4: Basic Tests with positive exponents
assertCrossRateEquals(100, 2, 100, 2, -5, 100000); // 100 * 10^2 / 100 * 10^2 = 10000 / 10000 = 1 == 100000 * 10^-5
// We will loose preistion as the the target exponent is 5 making the price 0.00001
assertCrossRateEquals(100, 8, 100, 8, 5, 0);
assertCrossRateEquals(100, 2, 100, 2, -5, 100000); // 100 * 10^2 / 100 * 10^2 = 10000 / 10000 = 1
// We will loose preistion as the the target exponent is 5 making the price 0.00001
assertCrossRateEquals(100, 2, 100, 2, 5, 0);

// Test 5: Different Exponent Tests
assertCrossRateEquals(10_000, -2, 100, -4, 0, 10_000); // 10_000 / 100 = 100 * 10(-2 - -4) = 10_000 with 0 decimals = 10_000
assertCrossRateEquals(10_000, -2, 100, -4, 5, 0); // 10_000 / 100 = 100 * 10(-2 - -4) = 10_000 with 5 decimals = 0
assertCrossRateEquals(10_000, -2, 10_000, -1, 5, 0); // It will truncate to 0
assertCrossRateEquals(10_000, -10, 10_000, -2, 0, 0); // It will truncate to 0

assertCrossRateEquals(100_000_000, -2, 100, -8, -8, 100_000_000_000_000_000_000); // 100_000_000 / 100 = 1_000_000 * 10(-2 - -8) = 1000000 * 10^6 = 1000000000000

// Exponent Edge Tests
console.log("\nExponent Edge Tests");
assertCrossRateEquals(10_000, 0, 100, 0, 0, 100);
assertCrossRateReverts(10_000, 0, 100, 0, -255, PythErrors.ExponentOverflow.selector);
assertCrossRateReverts(10_000, 0, 100, -255, -255, PythErrors.ExponentOverflow.selector);
assertCrossRateReverts(10_000, -255, 100, 0, 0, PythErrors.ExponentOverflow.selector);
assertCrossRateReverts(10_000, -255, 100, -178, -5, PythErrors.ExponentOverflow.selector);

console.log("\nRealistic Tests");
// Realistic Tests
// Test case 1: (StEth/Eth / Eth/USD = ETH/BTC)
int256 price = PythUtils.deriveCrossRate(206487956502, -8, 206741615681, -8, -8);
assertApproxEqRel(price, 100000000, 9e17); // $1

// Test case 2:
price = PythUtils.deriveCrossRate(520010, -8, 38591, -8, -8);
assertApproxEqRel(price, 1347490347, 9e17); // $13.47

// Test case 3:
price = PythUtils.deriveCrossRate(520010, -8, 38591, -8, -12);
assertApproxEqRel(price, 13474903475432, 9e17); // $13.47
}
}
Loading
Loading