| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182 |
- // SPDX-License-Identifier: Apache 2
- pragma solidity ^0.8.0;
- import "forge-std/Test.sol";
- import "@pythnetwork/pyth-sdk-solidity/IPyth.sol";
- import "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
- import "./utils/PulseTestUtils.t.sol";
- import "../contracts/pulse/PulseUpgradeable.sol";
- import "../contracts/pulse/IPulse.sol";
- import "../contracts/pulse/PulseState.sol";
- import "../contracts/pulse/PulseEvents.sol";
- import "../contracts/pulse/PulseErrors.sol";
- contract MockPulseConsumer is IPulseConsumer {
- address private _pulse;
- uint64 public lastSequenceNumber;
- PythStructs.PriceFeed[] private _lastPriceFeeds;
- constructor(address pulse) {
- _pulse = pulse;
- }
- function getPulse() internal view override returns (address) {
- return _pulse;
- }
- function pulseCallback(
- uint64 sequenceNumber,
- PythStructs.PriceFeed[] memory priceFeeds
- ) internal override {
- lastSequenceNumber = sequenceNumber;
- for (uint i = 0; i < priceFeeds.length; i++) {
- _lastPriceFeeds.push(priceFeeds[i]);
- }
- }
- function lastPriceFeeds()
- external
- view
- returns (PythStructs.PriceFeed[] memory)
- {
- return _lastPriceFeeds;
- }
- }
- contract FailingPulseConsumer is IPulseConsumer {
- address private _pulse;
- constructor(address pulse) {
- _pulse = pulse;
- }
- function getPulse() internal view override returns (address) {
- return _pulse;
- }
- function pulseCallback(
- uint64,
- PythStructs.PriceFeed[] memory
- ) internal pure override {
- revert("callback failed");
- }
- }
- contract CustomErrorPulseConsumer is IPulseConsumer {
- error CustomError(string message);
- address private _pulse;
- constructor(address pulse) {
- _pulse = pulse;
- }
- function getPulse() internal view override returns (address) {
- return _pulse;
- }
- function pulseCallback(
- uint64,
- PythStructs.PriceFeed[] memory
- ) internal pure override {
- revert CustomError("callback failed");
- }
- }
- // FIXME: this shouldn't be IPulseConsumer.
- contract PulseTest is Test, PulseEvents, IPulseConsumer, PulseTestUtils {
- ERC1967Proxy public proxy;
- PulseUpgradeable public pulse;
- MockPulseConsumer public consumer;
- address public owner;
- address public admin;
- address public pyth;
- address public defaultProvider;
- // Constants
- uint128 constant PYTH_FEE = 1 wei;
- uint128 constant DEFAULT_PROVIDER_FEE_PER_GAS = 1 wei;
- uint128 constant DEFAULT_PROVIDER_BASE_FEE = 1 wei;
- uint128 constant DEFAULT_PROVIDER_FEE_PER_FEED = 10 wei;
- function setUp() public {
- owner = address(1);
- admin = address(2);
- pyth = address(3);
- defaultProvider = address(4);
- PulseUpgradeable _pulse = new PulseUpgradeable();
- proxy = new ERC1967Proxy(address(_pulse), "");
- pulse = PulseUpgradeable(address(proxy));
- pulse.initialize(
- owner,
- admin,
- PYTH_FEE,
- pyth,
- defaultProvider,
- false,
- 15
- );
- vm.prank(defaultProvider);
- pulse.registerProvider(
- DEFAULT_PROVIDER_BASE_FEE,
- DEFAULT_PROVIDER_FEE_PER_FEED,
- DEFAULT_PROVIDER_FEE_PER_GAS
- );
- consumer = new MockPulseConsumer(address(proxy));
- }
- // Helper function to calculate total fee
- // FIXME: I think this helper probably needs to take some arguments.
- function calculateTotalFee() internal view returns (uint128) {
- return
- pulse.getFee(defaultProvider, CALLBACK_GAS_LIMIT, createPriceIds());
- }
- function testRequestPriceUpdate() public {
- // Set a realistic gas price
- vm.txGasPrice(30 gwei);
- bytes32[] memory priceIds = createPriceIds();
- uint64 publishTime = SafeCast.toUint64(block.timestamp);
- // Fund the consumer contract with enough ETH for higher gas price
- vm.deal(address(consumer), 1 ether);
- uint128 totalFee = calculateTotalFee();
- // Create the event data we expect to see
- PulseState.Request memory expectedRequest = PulseState.Request({
- sequenceNumber: 1,
- publishTime: publishTime,
- priceIds: [
- priceIds[0],
- priceIds[1],
- bytes32(0), // Fill remaining slots with zero
- bytes32(0),
- bytes32(0),
- bytes32(0),
- bytes32(0),
- bytes32(0),
- bytes32(0),
- bytes32(0)
- ],
- numPriceIds: 2,
- callbackGasLimit: CALLBACK_GAS_LIMIT,
- requester: address(consumer),
- provider: defaultProvider,
- fee: totalFee - PYTH_FEE
- });
- vm.expectEmit();
- emit PriceUpdateRequested(expectedRequest, priceIds);
- vm.prank(address(consumer));
- pulse.requestPriceUpdatesWithCallback{value: totalFee}(
- defaultProvider,
- publishTime,
- priceIds,
- CALLBACK_GAS_LIMIT
- );
- // Additional assertions to verify event data was stored correctly
- PulseState.Request memory lastRequest = pulse.getRequest(1);
- assertEq(lastRequest.sequenceNumber, expectedRequest.sequenceNumber);
- assertEq(lastRequest.publishTime, expectedRequest.publishTime);
- assertEq(lastRequest.numPriceIds, expectedRequest.numPriceIds);
- for (uint8 i = 0; i < lastRequest.numPriceIds; i++) {
- assertEq(lastRequest.priceIds[i], expectedRequest.priceIds[i]);
- }
- assertEq(
- lastRequest.callbackGasLimit,
- expectedRequest.callbackGasLimit
- );
- assertEq(
- lastRequest.requester,
- expectedRequest.requester,
- "Requester mismatch"
- );
- }
- function testRequestWithInsufficientFee() public {
- // Set a realistic gas price
- vm.txGasPrice(30 gwei);
- bytes32[] memory priceIds = createPriceIds();
- vm.deal(address(consumer), 1 ether);
- vm.prank(address(consumer));
- vm.expectRevert(InsufficientFee.selector);
- pulse.requestPriceUpdatesWithCallback{value: PYTH_FEE}( // Intentionally low fee
- defaultProvider,
- SafeCast.toUint64(block.timestamp),
- priceIds,
- CALLBACK_GAS_LIMIT
- );
- }
- function testExecuteCallback() public {
- bytes32[] memory priceIds = createPriceIds();
- uint64 publishTime = SafeCast.toUint64(block.timestamp);
- // Fund the consumer contract
- vm.deal(address(consumer), 1 gwei);
- uint128 totalFee = calculateTotalFee();
- // Step 1: Make the request as consumer
- vm.prank(address(consumer));
- uint64 sequenceNumber = pulse.requestPriceUpdatesWithCallback{
- value: totalFee
- }(defaultProvider, publishTime, priceIds, CALLBACK_GAS_LIMIT);
- // Step 2: Create mock price feeds and setup Pyth response
- PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
- publishTime
- );
- // FIXME: this test doesn't ensure the Pyth fee is paid.
- mockParsePriceFeedUpdates(pyth, priceFeeds);
- // Create arrays for expected event data
- int64[] memory expectedPrices = new int64[](2);
- expectedPrices[0] = MOCK_BTC_PRICE;
- expectedPrices[1] = MOCK_ETH_PRICE;
- uint64[] memory expectedConf = new uint64[](2);
- expectedConf[0] = MOCK_BTC_CONF;
- expectedConf[1] = MOCK_ETH_CONF;
- int32[] memory expectedExpos = new int32[](2);
- expectedExpos[0] = MOCK_PRICE_FEED_EXPO;
- expectedExpos[1] = MOCK_PRICE_FEED_EXPO;
- uint64[] memory expectedPublishTimes = new uint64[](2);
- expectedPublishTimes[0] = publishTime;
- expectedPublishTimes[1] = publishTime;
- // Expect the PriceUpdateExecuted event with all price data
- vm.expectEmit();
- emit PriceUpdateExecuted(
- sequenceNumber,
- defaultProvider,
- priceIds,
- expectedPrices,
- expectedConf,
- expectedExpos,
- expectedPublishTimes
- );
- // Create mock update data and execute callback
- bytes[] memory updateData = createMockUpdateData(priceFeeds);
- vm.prank(defaultProvider);
- pulse.executeCallback(
- defaultProvider,
- sequenceNumber,
- updateData,
- priceIds
- );
- // Verify callback was executed
- assertEq(consumer.lastSequenceNumber(), sequenceNumber);
- // Compare price feeds array length
- PythStructs.PriceFeed[] memory lastFeeds = consumer.lastPriceFeeds();
- assertEq(lastFeeds.length, priceFeeds.length);
- // Compare each price feed
- for (uint i = 0; i < priceFeeds.length; i++) {
- assertEq(lastFeeds[i].id, priceFeeds[i].id);
- assertEq(lastFeeds[i].price.price, priceFeeds[i].price.price);
- assertEq(lastFeeds[i].price.conf, priceFeeds[i].price.conf);
- assertEq(lastFeeds[i].price.expo, priceFeeds[i].price.expo);
- assertEq(
- lastFeeds[i].price.publishTime,
- priceFeeds[i].price.publishTime
- );
- }
- }
- function testExecuteCallbackFailure() public {
- FailingPulseConsumer failingConsumer = new FailingPulseConsumer(
- address(proxy)
- );
- (
- uint64 sequenceNumber,
- bytes32[] memory priceIds,
- uint256 publishTime
- ) = setupConsumerRequest(
- pulse,
- defaultProvider,
- address(failingConsumer)
- );
- PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
- publishTime
- );
- mockParsePriceFeedUpdates(pyth, priceFeeds);
- bytes[] memory updateData = createMockUpdateData(priceFeeds);
- vm.expectEmit();
- emit PriceUpdateCallbackFailed(
- sequenceNumber,
- defaultProvider,
- priceIds,
- address(failingConsumer),
- "callback failed"
- );
- vm.prank(defaultProvider);
- pulse.executeCallback(
- defaultProvider,
- sequenceNumber,
- updateData,
- priceIds
- );
- }
- function testExecuteCallbackCustomErrorFailure() public {
- CustomErrorPulseConsumer failingConsumer = new CustomErrorPulseConsumer(
- address(proxy)
- );
- (
- uint64 sequenceNumber,
- bytes32[] memory priceIds,
- uint256 publishTime
- ) = setupConsumerRequest(
- pulse,
- defaultProvider,
- address(failingConsumer)
- );
- PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
- publishTime
- );
- mockParsePriceFeedUpdates(pyth, priceFeeds);
- bytes[] memory updateData = createMockUpdateData(priceFeeds);
- vm.expectEmit();
- emit PriceUpdateCallbackFailed(
- sequenceNumber,
- defaultProvider,
- priceIds,
- address(failingConsumer),
- "low-level error (possibly out of gas)"
- );
- vm.prank(defaultProvider);
- pulse.executeCallback(
- defaultProvider,
- sequenceNumber,
- updateData,
- priceIds
- );
- }
- function testExecuteCallbackWithInsufficientGas() public {
- // Setup request with 1M gas limit
- (
- uint64 sequenceNumber,
- bytes32[] memory priceIds,
- uint256 publishTime
- ) = setupConsumerRequest(pulse, defaultProvider, address(consumer));
- // Setup mock data
- PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
- publishTime
- );
- mockParsePriceFeedUpdates(pyth, priceFeeds);
- bytes[] memory updateData = createMockUpdateData(priceFeeds);
- // Try executing with only 100K gas when 1M is required
- vm.prank(defaultProvider);
- vm.expectRevert(); // Just expect any revert since it will be an out-of-gas error
- pulse.executeCallback{gas: 100000}(
- defaultProvider,
- sequenceNumber,
- updateData,
- priceIds
- ); // Will fail because gasleft() < callbackGasLimit
- }
- function testExecuteCallbackWithFutureTimestamp() public {
- // Setup request with future timestamp
- bytes32[] memory priceIds = createPriceIds();
- uint64 futureTime = SafeCast.toUint64(block.timestamp + 10); // 10 seconds in future
- vm.deal(address(consumer), 1 gwei);
- uint128 totalFee = calculateTotalFee();
- vm.prank(address(consumer));
- uint64 sequenceNumber = pulse.requestPriceUpdatesWithCallback{
- value: totalFee
- }(defaultProvider, futureTime, priceIds, CALLBACK_GAS_LIMIT);
- // Try to execute callback before the requested timestamp
- PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
- futureTime // Mock price feeds with future timestamp
- );
- mockParsePriceFeedUpdates(pyth, priceFeeds); // This will make parsePriceFeedUpdates return future-dated prices
- bytes[] memory updateData = createMockUpdateData(priceFeeds);
- vm.prank(defaultProvider);
- // Should succeed because we're simulating receiving future-dated price updates
- pulse.executeCallback(
- defaultProvider,
- sequenceNumber,
- updateData,
- priceIds
- );
- // Compare price feeds array length
- PythStructs.PriceFeed[] memory lastFeeds = consumer.lastPriceFeeds();
- assertEq(lastFeeds.length, priceFeeds.length);
- // Compare each price feed publish time
- for (uint i = 0; i < priceFeeds.length; i++) {
- assertEq(
- lastFeeds[i].price.publishTime,
- priceFeeds[i].price.publishTime
- );
- }
- }
- function testRevertOnTooFarFutureTimestamp() public {
- bytes32[] memory priceIds = createPriceIds();
- uint64 farFutureTime = SafeCast.toUint64(block.timestamp + 61); // Just over 1 minute
- vm.deal(address(consumer), 1 gwei);
- uint128 totalFee = calculateTotalFee();
- vm.prank(address(consumer));
- vm.expectRevert("Too far in future");
- pulse.requestPriceUpdatesWithCallback{value: totalFee}(
- defaultProvider,
- farFutureTime,
- priceIds,
- CALLBACK_GAS_LIMIT
- );
- }
- function testDoubleExecuteCallback() public {
- (
- uint64 sequenceNumber,
- bytes32[] memory priceIds,
- uint256 publishTime
- ) = setupConsumerRequest(pulse, defaultProvider, address(consumer));
- PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
- publishTime
- );
- mockParsePriceFeedUpdates(pyth, priceFeeds);
- bytes[] memory updateData = createMockUpdateData(priceFeeds);
- // First execution
- vm.prank(defaultProvider);
- pulse.executeCallback(
- defaultProvider,
- sequenceNumber,
- updateData,
- priceIds
- );
- // Second execution should fail
- vm.prank(defaultProvider);
- vm.expectRevert(NoSuchRequest.selector);
- pulse.executeCallback(
- defaultProvider,
- sequenceNumber,
- updateData,
- priceIds
- );
- }
- function testGetFee() public {
- // Test with different gas limits to verify fee calculation
- uint256[] memory gasLimits = new uint256[](3);
- gasLimits[0] = 100_000;
- gasLimits[1] = 500_000;
- gasLimits[2] = 1_000_000;
- bytes32[] memory priceIds = createPriceIds();
- for (uint256 i = 0; i < gasLimits.length; i++) {
- uint256 gasLimit = gasLimits[i];
- uint128 expectedFee = SafeCast.toUint128(
- DEFAULT_PROVIDER_BASE_FEE +
- DEFAULT_PROVIDER_FEE_PER_FEED *
- priceIds.length +
- DEFAULT_PROVIDER_FEE_PER_GAS *
- gasLimit
- ) + PYTH_FEE;
- uint128 actualFee = pulse.getFee(
- defaultProvider,
- gasLimit,
- priceIds
- );
- assertEq(
- actualFee,
- expectedFee,
- "Fee calculation incorrect for gas limit"
- );
- }
- // Test with zero gas limit
- uint128 expectedMinFee = SafeCast.toUint128(
- PYTH_FEE +
- DEFAULT_PROVIDER_BASE_FEE +
- DEFAULT_PROVIDER_FEE_PER_FEED *
- priceIds.length
- );
- uint128 actualMinFee = pulse.getFee(defaultProvider, 0, priceIds);
- assertEq(
- actualMinFee,
- expectedMinFee,
- "Minimum fee calculation incorrect"
- );
- }
- function testWithdrawFees() public {
- // Setup: Request price update to accrue some fees
- bytes32[] memory priceIds = createPriceIds();
- vm.deal(address(consumer), 1 gwei);
- vm.prank(address(consumer));
- pulse.requestPriceUpdatesWithCallback{value: calculateTotalFee()}(
- defaultProvider,
- SafeCast.toUint64(block.timestamp),
- priceIds,
- CALLBACK_GAS_LIMIT
- );
- // Get admin's balance before withdrawal
- uint256 adminBalanceBefore = admin.balance;
- uint128 accruedFees = pulse.getAccruedPythFees();
- // Withdraw fees as admin
- vm.prank(admin);
- pulse.withdrawFees(accruedFees);
- // Verify balances
- assertEq(
- admin.balance,
- adminBalanceBefore + accruedFees,
- "Admin balance should increase by withdrawn amount"
- );
- assertEq(
- pulse.getAccruedPythFees(),
- 0,
- "Contract should have no fees after withdrawal"
- );
- }
- function testWithdrawFeesUnauthorized() public {
- vm.prank(address(0xdead));
- vm.expectRevert("Only admin can withdraw fees");
- pulse.withdrawFees(1 ether);
- }
- function testWithdrawFeesInsufficientBalance() public {
- vm.prank(admin);
- vm.expectRevert("Insufficient balance");
- pulse.withdrawFees(1 ether);
- }
- function testSetAndWithdrawAsFeeManager() public {
- address feeManager = address(0x789);
- vm.prank(defaultProvider);
- pulse.setFeeManager(feeManager);
- // Setup: Request price update to accrue some fees
- bytes32[] memory priceIds = createPriceIds();
- vm.deal(address(consumer), 1 gwei);
- vm.prank(address(consumer));
- pulse.requestPriceUpdatesWithCallback{value: calculateTotalFee()}(
- defaultProvider,
- SafeCast.toUint64(block.timestamp),
- priceIds,
- CALLBACK_GAS_LIMIT
- );
- // Get provider's accrued fees instead of total fees
- PulseState.ProviderInfo memory providerInfo = pulse.getProviderInfo(
- defaultProvider
- );
- uint128 providerAccruedFees = providerInfo.accruedFeesInWei;
- uint256 managerBalanceBefore = feeManager.balance;
- vm.prank(feeManager);
- pulse.withdrawAsFeeManager(defaultProvider, providerAccruedFees);
- assertEq(
- feeManager.balance,
- managerBalanceBefore + providerAccruedFees,
- "Fee manager balance should increase by withdrawn amount"
- );
- providerInfo = pulse.getProviderInfo(defaultProvider);
- assertEq(
- providerInfo.accruedFeesInWei,
- 0,
- "Provider should have no fees after withdrawal"
- );
- }
- function testSetFeeManagerUnauthorized() public {
- address feeManager = address(0x789);
- vm.prank(address(0xdead));
- vm.expectRevert("Provider not registered");
- pulse.setFeeManager(feeManager);
- }
- function testWithdrawAsFeeManagerUnauthorized() public {
- vm.prank(address(0xdead));
- vm.expectRevert("Only fee manager");
- pulse.withdrawAsFeeManager(defaultProvider, 1 ether);
- }
- function testWithdrawAsFeeManagerInsufficientBalance() public {
- // Set up fee manager first
- address feeManager = address(0x789);
- vm.prank(defaultProvider);
- pulse.setFeeManager(feeManager);
- vm.prank(feeManager);
- vm.expectRevert("Insufficient balance");
- pulse.withdrawAsFeeManager(defaultProvider, 1 ether);
- }
- // Add new test for invalid priceIds
- function testExecuteCallbackWithInvalidPriceIds() public {
- bytes32[] memory priceIds = createPriceIds();
- uint256 publishTime = block.timestamp;
- // Setup request
- (uint64 sequenceNumber, , ) = setupConsumerRequest(
- pulse,
- defaultProvider,
- address(consumer)
- );
- // Create different priceIds
- bytes32[] memory wrongPriceIds = new bytes32[](2);
- wrongPriceIds[0] = bytes32(uint256(1)); // Different price IDs
- wrongPriceIds[1] = bytes32(uint256(2));
- PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
- publishTime
- );
- mockParsePriceFeedUpdates(pyth, priceFeeds);
- bytes[] memory updateData = createMockUpdateData(priceFeeds);
- // Should revert when trying to execute with wrong priceIds
- vm.prank(defaultProvider);
- vm.expectRevert(
- abi.encodeWithSelector(
- InvalidPriceIds.selector,
- wrongPriceIds[0],
- priceIds[0]
- )
- );
- pulse.executeCallback(
- defaultProvider,
- sequenceNumber,
- updateData,
- wrongPriceIds
- );
- }
- function testRevertOnTooManyPriceIds() public {
- uint256 maxPriceIds = uint256(pulse.MAX_PRICE_IDS());
- // Create array with MAX_PRICE_IDS + 1 price IDs
- bytes32[] memory priceIds = new bytes32[](maxPriceIds + 1);
- for (uint i = 0; i < priceIds.length; i++) {
- priceIds[i] = bytes32(uint256(i + 1));
- }
- vm.deal(address(consumer), 1 gwei);
- uint128 totalFee = calculateTotalFee();
- vm.prank(address(consumer));
- vm.expectRevert(
- abi.encodeWithSelector(
- TooManyPriceIds.selector,
- maxPriceIds + 1,
- maxPriceIds
- )
- );
- pulse.requestPriceUpdatesWithCallback{value: totalFee}(
- defaultProvider,
- SafeCast.toUint64(block.timestamp),
- priceIds,
- CALLBACK_GAS_LIMIT
- );
- }
- function testProviderRegistration() public {
- address provider = address(0x123);
- uint128 providerFee = 1000;
- vm.prank(provider);
- pulse.registerProvider(providerFee, providerFee, providerFee);
- PulseState.ProviderInfo memory info = pulse.getProviderInfo(provider);
- assertEq(info.feePerGasInWei, providerFee);
- assertTrue(info.isRegistered);
- }
- function testSetProviderFee() public {
- address provider = address(0x123);
- uint128 initialBaseFee = 1000;
- uint128 initialFeePerFeed = 2000;
- uint128 initialFeePerGas = 3000;
- uint128 newFeePerFeed = 4000;
- uint128 newBaseFee = 5000;
- uint128 newFeePerGas = 6000;
- vm.prank(provider);
- pulse.registerProvider(
- initialBaseFee,
- initialFeePerFeed,
- initialFeePerGas
- );
- vm.prank(provider);
- pulse.setProviderFee(provider, newBaseFee, newFeePerFeed, newFeePerGas);
- PulseState.ProviderInfo memory info = pulse.getProviderInfo(provider);
- assertEq(info.baseFeeInWei, newBaseFee);
- assertEq(info.feePerFeedInWei, newFeePerFeed);
- assertEq(info.feePerGasInWei, newFeePerGas);
- }
- function testDefaultProvider() public {
- address provider = address(0x123);
- uint128 providerFee = 1000;
- vm.prank(provider);
- pulse.registerProvider(providerFee, providerFee, providerFee);
- vm.prank(admin);
- pulse.setDefaultProvider(provider);
- assertEq(pulse.getDefaultProvider(), provider);
- }
- function testRequestWithProvider() public {
- address provider = address(0x123);
- uint128 providerFee = 1000;
- vm.prank(provider);
- pulse.registerProvider(providerFee, providerFee, providerFee);
- bytes32[] memory priceIds = new bytes32[](1);
- priceIds[0] = bytes32(uint256(1));
- uint128 totalFee = pulse.getFee(provider, CALLBACK_GAS_LIMIT, priceIds);
- vm.deal(address(consumer), totalFee);
- vm.prank(address(consumer));
- uint64 sequenceNumber = pulse.requestPriceUpdatesWithCallback{
- value: totalFee
- }(
- provider,
- SafeCast.toUint64(block.timestamp),
- priceIds,
- CALLBACK_GAS_LIMIT
- );
- PulseState.Request memory req = pulse.getRequest(sequenceNumber);
- assertEq(req.provider, provider);
- }
- function testExclusivityPeriod() public {
- // Test initial value
- assertEq(
- pulse.getExclusivityPeriod(),
- 15,
- "Initial exclusivity period should be 15 seconds"
- );
- // Test setting new value
- vm.prank(admin);
- vm.expectEmit();
- emit ExclusivityPeriodUpdated(15, 30);
- pulse.setExclusivityPeriod(30);
- assertEq(
- pulse.getExclusivityPeriod(),
- 30,
- "Exclusivity period should be updated"
- );
- }
- function testSetExclusivityPeriodUnauthorized() public {
- vm.prank(address(0xdead));
- vm.expectRevert("Only admin can set exclusivity period");
- pulse.setExclusivityPeriod(30);
- }
- function testExecuteCallbackDuringExclusivity() public {
- // Register a second provider
- address secondProvider = address(0x456);
- vm.prank(secondProvider);
- pulse.registerProvider(
- DEFAULT_PROVIDER_BASE_FEE,
- DEFAULT_PROVIDER_FEE_PER_FEED,
- DEFAULT_PROVIDER_FEE_PER_GAS
- );
- // Setup request
- (
- uint64 sequenceNumber,
- bytes32[] memory priceIds,
- uint256 publishTime
- ) = setupConsumerRequest(pulse, defaultProvider, address(consumer));
- // Setup mock data
- PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
- publishTime
- );
- mockParsePriceFeedUpdates(pyth, priceFeeds);
- bytes[] memory updateData = createMockUpdateData(priceFeeds);
- // Try to execute with second provider during exclusivity period
- vm.expectRevert("Only assigned provider during exclusivity period");
- pulse.executeCallback(
- secondProvider,
- sequenceNumber,
- updateData,
- priceIds
- );
- // Original provider should succeed
- pulse.executeCallback(
- defaultProvider,
- sequenceNumber,
- updateData,
- priceIds
- );
- }
- function testExecuteCallbackAfterExclusivity() public {
- // Register a second provider
- address secondProvider = address(0x456);
- vm.prank(secondProvider);
- pulse.registerProvider(
- DEFAULT_PROVIDER_BASE_FEE,
- DEFAULT_PROVIDER_FEE_PER_FEED,
- DEFAULT_PROVIDER_FEE_PER_GAS
- );
- // Setup request
- (
- uint64 sequenceNumber,
- bytes32[] memory priceIds,
- uint256 publishTime
- ) = setupConsumerRequest(pulse, defaultProvider, address(consumer));
- // Setup mock data
- PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
- publishTime
- );
- mockParsePriceFeedUpdates(pyth, priceFeeds);
- bytes[] memory updateData = createMockUpdateData(priceFeeds);
- // Wait for exclusivity period to end
- vm.warp(block.timestamp + pulse.getExclusivityPeriod() + 1);
- // Second provider should now succeed
- vm.prank(secondProvider);
- pulse.executeCallback(
- defaultProvider,
- sequenceNumber,
- updateData,
- priceIds
- );
- }
- function testExecuteCallbackWithCustomExclusivityPeriod() public {
- // Register a second provider
- address secondProvider = address(0x456);
- vm.prank(secondProvider);
- pulse.registerProvider(
- DEFAULT_PROVIDER_BASE_FEE,
- DEFAULT_PROVIDER_FEE_PER_FEED,
- DEFAULT_PROVIDER_FEE_PER_GAS
- );
- // Set custom exclusivity period
- vm.prank(admin);
- pulse.setExclusivityPeriod(30);
- // Setup request
- (
- uint64 sequenceNumber,
- bytes32[] memory priceIds,
- uint256 publishTime
- ) = setupConsumerRequest(pulse, defaultProvider, address(consumer));
- // Setup mock data
- PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
- publishTime
- );
- mockParsePriceFeedUpdates(pyth, priceFeeds);
- bytes[] memory updateData = createMockUpdateData(priceFeeds);
- // Try at 29 seconds (should fail for second provider)
- vm.warp(block.timestamp + 29);
- vm.expectRevert("Only assigned provider during exclusivity period");
- pulse.executeCallback(
- secondProvider,
- sequenceNumber,
- updateData,
- priceIds
- );
- // Try at 31 seconds (should succeed for second provider)
- vm.warp(block.timestamp + 2);
- pulse.executeCallback(
- secondProvider,
- sequenceNumber,
- updateData,
- priceIds
- );
- }
- function testGetFirstActiveRequests() public {
- // Setup test data
- (
- bytes32[] memory priceIds,
- bytes[] memory updateData
- ) = setupTestData();
- createTestRequests(priceIds);
- completeRequests(updateData, priceIds);
- testRequestScenarios(priceIds, updateData);
- }
- function setupTestData()
- private
- pure
- returns (bytes32[] memory, bytes[] memory)
- {
- bytes32[] memory priceIds = new bytes32[](1);
- priceIds[0] = bytes32(uint256(1));
- bytes[] memory updateData = new bytes[](1);
- return (priceIds, updateData);
- }
- function createTestRequests(bytes32[] memory priceIds) private {
- uint64 publishTime = SafeCast.toUint64(block.timestamp);
- for (uint i = 0; i < 5; i++) {
- vm.deal(address(this), 1 ether);
- pulse.requestPriceUpdatesWithCallback{value: 1 ether}(
- defaultProvider,
- publishTime,
- priceIds,
- 1000000
- );
- }
- }
- function completeRequests(
- bytes[] memory updateData,
- bytes32[] memory priceIds
- ) private {
- // Create mock price feeds and setup Pyth response
- PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
- SafeCast.toUint64(block.timestamp)
- );
- mockParsePriceFeedUpdates(pyth, priceFeeds);
- updateData = createMockUpdateData(priceFeeds);
- vm.deal(defaultProvider, 2 ether); // Increase ETH allocation to prevent OutOfFunds
- vm.startPrank(defaultProvider);
- pulse.executeCallback{value: 1 ether}(
- defaultProvider,
- 2,
- updateData,
- priceIds
- );
- pulse.executeCallback{value: 1 ether}(
- defaultProvider,
- 4,
- updateData,
- priceIds
- );
- vm.stopPrank();
- }
- function testRequestScenarios(
- bytes32[] memory priceIds,
- bytes[] memory updateData
- ) private {
- // Test 1: Request more than available
- checkMoreThanAvailable();
- // Test 2: Request exact number
- checkExactNumber();
- // Test 3: Request fewer than available
- checkFewerThanAvailable();
- // Test 4: Request zero
- checkZeroRequest();
- // Test 5: Clear all and check empty
- clearAllRequests(updateData, priceIds);
- checkEmptyState();
- }
- // Split test scenarios into separate functions
- function checkMoreThanAvailable() private {
- (PulseState.Request[] memory requests, uint256 count) = pulse
- .getFirstActiveRequests(10);
- assertEq(count, 3, "Should find 3 active requests");
- assertEq(requests.length, 3, "Array should be resized to 3");
- assertEq(
- requests[0].sequenceNumber,
- 1,
- "First request should be oldest"
- );
- assertEq(requests[1].sequenceNumber, 3, "Second request should be #3");
- assertEq(requests[2].sequenceNumber, 5, "Third request should be #5");
- }
- function checkExactNumber() private {
- (PulseState.Request[] memory requests, uint256 count) = pulse
- .getFirstActiveRequests(3);
- assertEq(count, 3, "Should find 3 active requests");
- assertEq(requests.length, 3, "Array should match requested size");
- }
- function checkFewerThanAvailable() private {
- (PulseState.Request[] memory requests, uint256 count) = pulse
- .getFirstActiveRequests(2);
- assertEq(count, 2, "Should find 2 active requests");
- assertEq(requests.length, 2, "Array should match requested size");
- assertEq(
- requests[0].sequenceNumber,
- 1,
- "First request should be oldest"
- );
- assertEq(requests[1].sequenceNumber, 3, "Second request should be #3");
- }
- function checkZeroRequest() private {
- (PulseState.Request[] memory requests, uint256 count) = pulse
- .getFirstActiveRequests(0);
- assertEq(count, 0, "Should find 0 active requests");
- assertEq(requests.length, 0, "Array should be empty");
- }
- function clearAllRequests(
- bytes[] memory updateData,
- bytes32[] memory priceIds
- ) private {
- vm.deal(defaultProvider, 3 ether); // Increase ETH allocation
- vm.startPrank(defaultProvider);
- pulse.executeCallback{value: 1 ether}(
- defaultProvider,
- 1,
- updateData,
- priceIds
- );
- pulse.executeCallback{value: 1 ether}(
- defaultProvider,
- 3,
- updateData,
- priceIds
- );
- pulse.executeCallback{value: 1 ether}(
- defaultProvider,
- 5,
- updateData,
- priceIds
- );
- vm.stopPrank();
- }
- function checkEmptyState() private {
- (PulseState.Request[] memory requests, uint256 count) = pulse
- .getFirstActiveRequests(10);
- assertEq(count, 0, "Should find 0 active requests");
- assertEq(requests.length, 0, "Array should be empty");
- }
- function testGetFirstActiveRequestsGasUsage() public {
- // Setup test data
- bytes32[] memory priceIds = new bytes32[](1);
- priceIds[0] = bytes32(uint256(1));
- uint64 publishTime = SafeCast.toUint64(block.timestamp);
- uint256 callbackGasLimit = 1000000;
- // Create mock price feeds and setup Pyth response
- PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
- publishTime
- );
- mockParsePriceFeedUpdates(pyth, priceFeeds);
- bytes[] memory updateData = createMockUpdateData(priceFeeds);
- // Create 20 requests with some gaps
- for (uint i = 0; i < 20; i++) {
- vm.deal(address(this), 1 ether);
- pulse.requestPriceUpdatesWithCallback{value: 1 ether}(
- defaultProvider,
- publishTime,
- priceIds,
- callbackGasLimit
- );
- // Complete every third request to create gaps
- if (i % 3 == 0) {
- vm.deal(defaultProvider, 1 ether);
- vm.prank(defaultProvider);
- pulse.executeCallback{value: 1 ether}(
- defaultProvider,
- uint64(i + 1),
- updateData,
- priceIds
- );
- }
- }
- // Measure gas for different request counts
- uint256 gas1 = gasleft();
- pulse.getFirstActiveRequests(5);
- uint256 gas1Used = gas1 - gasleft();
- uint256 gas2 = gasleft();
- pulse.getFirstActiveRequests(10);
- uint256 gas2Used = gas2 - gasleft();
- // Log gas usage for analysis
- emit log_named_uint("Gas used for 5 requests", gas1Used);
- emit log_named_uint("Gas used for 10 requests", gas2Used);
- // Verify gas usage scales roughly linearly
- // Allow 10% margin for other factors
- assertApproxEqRel(
- gas2Used,
- gas1Used * 2,
- 0.1e18, // 10% tolerance
- "Gas usage should scale roughly linearly"
- );
- }
- function getPulse() internal view override returns (address) {
- return address(pulse);
- }
- // Mock implementation of pulseCallback
- function pulseCallback(
- uint64 sequenceNumber,
- PythStructs.PriceFeed[] memory priceFeeds
- ) internal override {
- // Just accept the callback, no need to do anything with the data
- // This prevents the revert we're seeing
- }
- }
|