Pulse.t.sol 35 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082
  1. // SPDX-License-Identifier: Apache 2
  2. pragma solidity ^0.8.0;
  3. import "forge-std/Test.sol";
  4. import "@pythnetwork/pyth-sdk-solidity/IPyth.sol";
  5. import "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
  6. import "../contracts/pulse/PulseUpgradeable.sol";
  7. import "../contracts/pulse/IPulse.sol";
  8. import "../contracts/pulse/PulseState.sol";
  9. import "../contracts/pulse/PulseEvents.sol";
  10. import "../contracts/pulse/PulseErrors.sol";
  11. contract MockPulseConsumer is IPulseConsumer {
  12. uint64 public lastSequenceNumber;
  13. PythStructs.PriceFeed[] private _lastPriceFeeds;
  14. function pulseCallback(
  15. uint64 sequenceNumber,
  16. PythStructs.PriceFeed[] memory priceFeeds
  17. ) external override {
  18. lastSequenceNumber = sequenceNumber;
  19. for (uint i = 0; i < priceFeeds.length; i++) {
  20. _lastPriceFeeds.push(priceFeeds[i]);
  21. }
  22. }
  23. function lastPriceFeeds()
  24. external
  25. view
  26. returns (PythStructs.PriceFeed[] memory)
  27. {
  28. return _lastPriceFeeds;
  29. }
  30. }
  31. contract FailingPulseConsumer is IPulseConsumer {
  32. function pulseCallback(
  33. uint64,
  34. PythStructs.PriceFeed[] memory
  35. ) external pure override {
  36. revert("callback failed");
  37. }
  38. }
  39. contract CustomErrorPulseConsumer is IPulseConsumer {
  40. error CustomError(string message);
  41. function pulseCallback(
  42. uint64,
  43. PythStructs.PriceFeed[] memory
  44. ) external pure override {
  45. revert CustomError("callback failed");
  46. }
  47. }
  48. contract PulseTest is Test, PulseEvents, IPulseConsumer {
  49. ERC1967Proxy public proxy;
  50. PulseUpgradeable public pulse;
  51. MockPulseConsumer public consumer;
  52. address public owner;
  53. address public admin;
  54. address public pyth;
  55. address public defaultProvider;
  56. // Constants
  57. uint128 constant PYTH_FEE = 1 wei;
  58. uint128 constant DEFAULT_PROVIDER_FEE = 1 wei;
  59. uint128 constant CALLBACK_GAS_LIMIT = 1_000_000;
  60. bytes32 constant BTC_PRICE_FEED_ID =
  61. 0xe62df6c8b4a85fe1a67db44dc12de5db330f7ac66b72dc658afedf0f4a415b43;
  62. bytes32 constant ETH_PRICE_FEED_ID =
  63. 0xff61491a931112ddf1bd8147cd1b641375f79f5825126d665480874634fd0ace;
  64. // Price feed constants
  65. int8 constant MOCK_PRICE_FEED_EXPO = -8;
  66. int64 constant MOCK_BTC_PRICE = 5_000_000_000_000; // $50,000
  67. int64 constant MOCK_ETH_PRICE = 300_000_000_000; // $3,000
  68. uint64 constant MOCK_BTC_CONF = 10_000_000_000; // $100
  69. uint64 constant MOCK_ETH_CONF = 5_000_000_000; // $50
  70. function setUp() public {
  71. owner = address(1);
  72. admin = address(2);
  73. pyth = address(3);
  74. defaultProvider = address(4);
  75. PulseUpgradeable _pulse = new PulseUpgradeable();
  76. proxy = new ERC1967Proxy(address(_pulse), "");
  77. pulse = PulseUpgradeable(address(proxy));
  78. pulse.initialize(
  79. owner,
  80. admin,
  81. PYTH_FEE,
  82. pyth,
  83. defaultProvider,
  84. false,
  85. 15
  86. );
  87. vm.prank(defaultProvider);
  88. pulse.registerProvider(DEFAULT_PROVIDER_FEE);
  89. consumer = new MockPulseConsumer();
  90. }
  91. // Helper function to create price IDs array
  92. function createPriceIds() internal pure returns (bytes32[] memory) {
  93. bytes32[] memory priceIds = new bytes32[](2);
  94. priceIds[0] = BTC_PRICE_FEED_ID;
  95. priceIds[1] = ETH_PRICE_FEED_ID;
  96. return priceIds;
  97. }
  98. // Helper function to create mock price feeds
  99. function createMockPriceFeeds(
  100. uint256 publishTime
  101. ) internal pure returns (PythStructs.PriceFeed[] memory) {
  102. PythStructs.PriceFeed[] memory priceFeeds = new PythStructs.PriceFeed[](
  103. 2
  104. );
  105. priceFeeds[0].id = BTC_PRICE_FEED_ID;
  106. priceFeeds[0].price.price = MOCK_BTC_PRICE;
  107. priceFeeds[0].price.conf = MOCK_BTC_CONF;
  108. priceFeeds[0].price.expo = MOCK_PRICE_FEED_EXPO;
  109. priceFeeds[0].price.publishTime = publishTime;
  110. priceFeeds[1].id = ETH_PRICE_FEED_ID;
  111. priceFeeds[1].price.price = MOCK_ETH_PRICE;
  112. priceFeeds[1].price.conf = MOCK_ETH_CONF;
  113. priceFeeds[1].price.expo = MOCK_PRICE_FEED_EXPO;
  114. priceFeeds[1].price.publishTime = publishTime;
  115. return priceFeeds;
  116. }
  117. // Helper function to mock Pyth response
  118. function mockParsePriceFeedUpdates(
  119. PythStructs.PriceFeed[] memory priceFeeds
  120. ) internal {
  121. vm.mockCall(
  122. address(pyth),
  123. abi.encodeWithSelector(IPyth.parsePriceFeedUpdates.selector),
  124. abi.encode(priceFeeds)
  125. );
  126. }
  127. // Helper function to create mock update data
  128. function createMockUpdateData(
  129. PythStructs.PriceFeed[] memory priceFeeds
  130. ) internal pure returns (bytes[] memory) {
  131. bytes[] memory updateData = new bytes[](2);
  132. updateData[0] = abi.encode(priceFeeds[0]);
  133. updateData[1] = abi.encode(priceFeeds[1]);
  134. return updateData;
  135. }
  136. // Helper function to calculate total fee
  137. function calculateTotalFee() internal view returns (uint128) {
  138. return pulse.getFee(CALLBACK_GAS_LIMIT);
  139. }
  140. // Helper function to setup consumer request
  141. function setupConsumerRequest(
  142. address consumerAddress
  143. )
  144. internal
  145. returns (
  146. uint64 sequenceNumber,
  147. bytes32[] memory priceIds,
  148. uint256 publishTime
  149. )
  150. {
  151. priceIds = createPriceIds();
  152. publishTime = block.timestamp;
  153. vm.deal(consumerAddress, 1 gwei);
  154. uint128 totalFee = calculateTotalFee();
  155. vm.prank(consumerAddress);
  156. sequenceNumber = pulse.requestPriceUpdatesWithCallback{value: totalFee}(
  157. publishTime,
  158. priceIds,
  159. CALLBACK_GAS_LIMIT
  160. );
  161. return (sequenceNumber, priceIds, publishTime);
  162. }
  163. function testRequestPriceUpdate() public {
  164. // Set a realistic gas price
  165. vm.txGasPrice(30 gwei);
  166. bytes32[] memory priceIds = createPriceIds();
  167. uint256 publishTime = block.timestamp;
  168. // Fund the consumer contract with enough ETH for higher gas price
  169. vm.deal(address(consumer), 1 ether);
  170. uint128 totalFee = calculateTotalFee();
  171. // Create the event data we expect to see
  172. PulseState.Request memory expectedRequest = PulseState.Request({
  173. sequenceNumber: 1,
  174. publishTime: publishTime,
  175. priceIds: [
  176. priceIds[0],
  177. priceIds[1],
  178. bytes32(0), // Fill remaining slots with zero
  179. bytes32(0),
  180. bytes32(0),
  181. bytes32(0),
  182. bytes32(0),
  183. bytes32(0),
  184. bytes32(0),
  185. bytes32(0)
  186. ],
  187. numPriceIds: 2,
  188. callbackGasLimit: CALLBACK_GAS_LIMIT,
  189. requester: address(consumer),
  190. provider: defaultProvider
  191. });
  192. vm.expectEmit();
  193. emit PriceUpdateRequested(expectedRequest, priceIds);
  194. vm.prank(address(consumer));
  195. pulse.requestPriceUpdatesWithCallback{value: totalFee}(
  196. publishTime,
  197. priceIds,
  198. CALLBACK_GAS_LIMIT
  199. );
  200. // Additional assertions to verify event data was stored correctly
  201. PulseState.Request memory lastRequest = pulse.getRequest(1);
  202. assertEq(lastRequest.sequenceNumber, expectedRequest.sequenceNumber);
  203. assertEq(lastRequest.publishTime, expectedRequest.publishTime);
  204. assertEq(lastRequest.numPriceIds, expectedRequest.numPriceIds);
  205. for (uint8 i = 0; i < lastRequest.numPriceIds; i++) {
  206. assertEq(lastRequest.priceIds[i], expectedRequest.priceIds[i]);
  207. }
  208. assertEq(
  209. lastRequest.callbackGasLimit,
  210. expectedRequest.callbackGasLimit
  211. );
  212. assertEq(
  213. lastRequest.requester,
  214. expectedRequest.requester,
  215. "Requester mismatch"
  216. );
  217. }
  218. function testRequestWithInsufficientFee() public {
  219. // Set a realistic gas price
  220. vm.txGasPrice(30 gwei);
  221. bytes32[] memory priceIds = createPriceIds();
  222. vm.deal(address(consumer), 1 ether);
  223. vm.prank(address(consumer));
  224. vm.expectRevert(InsufficientFee.selector);
  225. pulse.requestPriceUpdatesWithCallback{value: PYTH_FEE}( // Intentionally low fee
  226. block.timestamp,
  227. priceIds,
  228. CALLBACK_GAS_LIMIT
  229. );
  230. }
  231. function testExecuteCallback() public {
  232. bytes32[] memory priceIds = createPriceIds();
  233. uint256 publishTime = block.timestamp;
  234. // Fund the consumer contract
  235. vm.deal(address(consumer), 1 gwei);
  236. uint128 totalFee = calculateTotalFee();
  237. // Step 1: Make the request as consumer
  238. vm.prank(address(consumer));
  239. uint64 sequenceNumber = pulse.requestPriceUpdatesWithCallback{
  240. value: totalFee
  241. }(publishTime, priceIds, CALLBACK_GAS_LIMIT);
  242. // Step 2: Create mock price feeds and setup Pyth response
  243. PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
  244. publishTime
  245. );
  246. mockParsePriceFeedUpdates(priceFeeds);
  247. // Create arrays for expected event data
  248. int64[] memory expectedPrices = new int64[](2);
  249. expectedPrices[0] = MOCK_BTC_PRICE;
  250. expectedPrices[1] = MOCK_ETH_PRICE;
  251. uint64[] memory expectedConf = new uint64[](2);
  252. expectedConf[0] = MOCK_BTC_CONF;
  253. expectedConf[1] = MOCK_ETH_CONF;
  254. int32[] memory expectedExpos = new int32[](2);
  255. expectedExpos[0] = MOCK_PRICE_FEED_EXPO;
  256. expectedExpos[1] = MOCK_PRICE_FEED_EXPO;
  257. uint256[] memory expectedPublishTimes = new uint256[](2);
  258. expectedPublishTimes[0] = publishTime;
  259. expectedPublishTimes[1] = publishTime;
  260. // Expect the PriceUpdateExecuted event with all price data
  261. vm.expectEmit();
  262. emit PriceUpdateExecuted(
  263. sequenceNumber,
  264. defaultProvider,
  265. priceIds,
  266. expectedPrices,
  267. expectedConf,
  268. expectedExpos,
  269. expectedPublishTimes
  270. );
  271. // Create mock update data and execute callback
  272. bytes[] memory updateData = createMockUpdateData(priceFeeds);
  273. vm.prank(defaultProvider);
  274. pulse.executeCallback(sequenceNumber, updateData, priceIds);
  275. // Verify callback was executed
  276. assertEq(consumer.lastSequenceNumber(), sequenceNumber);
  277. // Compare price feeds array length
  278. PythStructs.PriceFeed[] memory lastFeeds = consumer.lastPriceFeeds();
  279. assertEq(lastFeeds.length, priceFeeds.length);
  280. // Compare each price feed
  281. for (uint i = 0; i < priceFeeds.length; i++) {
  282. assertEq(lastFeeds[i].id, priceFeeds[i].id);
  283. assertEq(lastFeeds[i].price.price, priceFeeds[i].price.price);
  284. assertEq(lastFeeds[i].price.conf, priceFeeds[i].price.conf);
  285. assertEq(lastFeeds[i].price.expo, priceFeeds[i].price.expo);
  286. assertEq(
  287. lastFeeds[i].price.publishTime,
  288. priceFeeds[i].price.publishTime
  289. );
  290. }
  291. }
  292. function testExecuteCallbackFailure() public {
  293. FailingPulseConsumer failingConsumer = new FailingPulseConsumer();
  294. (
  295. uint64 sequenceNumber,
  296. bytes32[] memory priceIds,
  297. uint256 publishTime
  298. ) = setupConsumerRequest(address(failingConsumer));
  299. PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
  300. publishTime
  301. );
  302. mockParsePriceFeedUpdates(priceFeeds);
  303. bytes[] memory updateData = createMockUpdateData(priceFeeds);
  304. vm.expectEmit();
  305. emit PriceUpdateCallbackFailed(
  306. sequenceNumber,
  307. defaultProvider,
  308. priceIds,
  309. address(failingConsumer),
  310. "callback failed"
  311. );
  312. vm.prank(defaultProvider);
  313. pulse.executeCallback(sequenceNumber, updateData, priceIds);
  314. }
  315. function testExecuteCallbackCustomErrorFailure() public {
  316. CustomErrorPulseConsumer failingConsumer = new CustomErrorPulseConsumer();
  317. (
  318. uint64 sequenceNumber,
  319. bytes32[] memory priceIds,
  320. uint256 publishTime
  321. ) = setupConsumerRequest(address(failingConsumer));
  322. PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
  323. publishTime
  324. );
  325. mockParsePriceFeedUpdates(priceFeeds);
  326. bytes[] memory updateData = createMockUpdateData(priceFeeds);
  327. vm.expectEmit();
  328. emit PriceUpdateCallbackFailed(
  329. sequenceNumber,
  330. defaultProvider,
  331. priceIds,
  332. address(failingConsumer),
  333. "low-level error (possibly out of gas)"
  334. );
  335. vm.prank(defaultProvider);
  336. pulse.executeCallback(sequenceNumber, updateData, priceIds);
  337. }
  338. function testExecuteCallbackWithInsufficientGas() public {
  339. // Setup request with 1M gas limit
  340. (
  341. uint64 sequenceNumber,
  342. bytes32[] memory priceIds,
  343. uint256 publishTime
  344. ) = setupConsumerRequest(address(consumer));
  345. // Setup mock data
  346. PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
  347. publishTime
  348. );
  349. mockParsePriceFeedUpdates(priceFeeds);
  350. bytes[] memory updateData = createMockUpdateData(priceFeeds);
  351. // Try executing with only 100K gas when 1M is required
  352. vm.prank(defaultProvider);
  353. vm.expectRevert(); // Just expect any revert since it will be an out-of-gas error
  354. pulse.executeCallback{gas: 100000}(
  355. sequenceNumber,
  356. updateData,
  357. priceIds
  358. ); // Will fail because gasleft() < callbackGasLimit
  359. }
  360. function testExecuteCallbackWithFutureTimestamp() public {
  361. // Setup request with future timestamp
  362. bytes32[] memory priceIds = createPriceIds();
  363. uint256 futureTime = block.timestamp + 10; // 10 seconds in future
  364. vm.deal(address(consumer), 1 gwei);
  365. uint128 totalFee = calculateTotalFee();
  366. vm.prank(address(consumer));
  367. uint64 sequenceNumber = pulse.requestPriceUpdatesWithCallback{
  368. value: totalFee
  369. }(futureTime, priceIds, CALLBACK_GAS_LIMIT);
  370. // Try to execute callback before the requested timestamp
  371. PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
  372. futureTime // Mock price feeds with future timestamp
  373. );
  374. mockParsePriceFeedUpdates(priceFeeds); // This will make parsePriceFeedUpdates return future-dated prices
  375. bytes[] memory updateData = createMockUpdateData(priceFeeds);
  376. vm.prank(defaultProvider);
  377. // Should succeed because we're simulating receiving future-dated price updates
  378. pulse.executeCallback(sequenceNumber, updateData, priceIds);
  379. // Compare price feeds array length
  380. PythStructs.PriceFeed[] memory lastFeeds = consumer.lastPriceFeeds();
  381. assertEq(lastFeeds.length, priceFeeds.length);
  382. // Compare each price feed publish time
  383. for (uint i = 0; i < priceFeeds.length; i++) {
  384. assertEq(
  385. lastFeeds[i].price.publishTime,
  386. priceFeeds[i].price.publishTime
  387. );
  388. }
  389. }
  390. function testRevertOnTooFarFutureTimestamp() public {
  391. bytes32[] memory priceIds = createPriceIds();
  392. uint256 farFutureTime = block.timestamp + 61; // Just over 1 minute
  393. vm.deal(address(consumer), 1 gwei);
  394. uint128 totalFee = calculateTotalFee();
  395. vm.prank(address(consumer));
  396. vm.expectRevert("Too far in future");
  397. pulse.requestPriceUpdatesWithCallback{value: totalFee}(
  398. farFutureTime,
  399. priceIds,
  400. CALLBACK_GAS_LIMIT
  401. );
  402. }
  403. function testDoubleExecuteCallback() public {
  404. (
  405. uint64 sequenceNumber,
  406. bytes32[] memory priceIds,
  407. uint256 publishTime
  408. ) = setupConsumerRequest(address(consumer));
  409. PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
  410. publishTime
  411. );
  412. mockParsePriceFeedUpdates(priceFeeds);
  413. bytes[] memory updateData = createMockUpdateData(priceFeeds);
  414. // First execution
  415. vm.prank(defaultProvider);
  416. pulse.executeCallback(sequenceNumber, updateData, priceIds);
  417. // Second execution should fail
  418. vm.prank(defaultProvider);
  419. vm.expectRevert(NoSuchRequest.selector);
  420. pulse.executeCallback(sequenceNumber, updateData, priceIds);
  421. }
  422. function testGetFee() public {
  423. // Test with different gas limits to verify fee calculation
  424. uint256[] memory gasLimits = new uint256[](3);
  425. gasLimits[0] = 100_000;
  426. gasLimits[1] = 500_000;
  427. gasLimits[2] = 1_000_000;
  428. for (uint256 i = 0; i < gasLimits.length; i++) {
  429. uint256 gasLimit = gasLimits[i];
  430. uint128 expectedFee = SafeCast.toUint128(
  431. DEFAULT_PROVIDER_FEE * gasLimit
  432. ) + PYTH_FEE;
  433. uint128 actualFee = pulse.getFee(gasLimit);
  434. assertEq(
  435. actualFee,
  436. expectedFee,
  437. "Fee calculation incorrect for gas limit"
  438. );
  439. }
  440. // Test with zero gas limit
  441. uint128 expectedMinFee = PYTH_FEE;
  442. uint128 actualMinFee = pulse.getFee(0);
  443. assertEq(
  444. actualMinFee,
  445. expectedMinFee,
  446. "Minimum fee calculation incorrect"
  447. );
  448. }
  449. function testWithdrawFees() public {
  450. // Setup: Request price update to accrue some fees
  451. bytes32[] memory priceIds = createPriceIds();
  452. vm.deal(address(consumer), 1 gwei);
  453. vm.prank(address(consumer));
  454. pulse.requestPriceUpdatesWithCallback{value: calculateTotalFee()}(
  455. block.timestamp,
  456. priceIds,
  457. CALLBACK_GAS_LIMIT
  458. );
  459. // Get admin's balance before withdrawal
  460. uint256 adminBalanceBefore = admin.balance;
  461. uint128 accruedFees = pulse.getAccruedFees();
  462. // Withdraw fees as admin
  463. vm.prank(admin);
  464. pulse.withdrawFees(accruedFees);
  465. // Verify balances
  466. assertEq(
  467. admin.balance,
  468. adminBalanceBefore + accruedFees,
  469. "Admin balance should increase by withdrawn amount"
  470. );
  471. assertEq(
  472. pulse.getAccruedFees(),
  473. 0,
  474. "Contract should have no fees after withdrawal"
  475. );
  476. }
  477. function testWithdrawFeesUnauthorized() public {
  478. vm.prank(address(0xdead));
  479. vm.expectRevert("Only admin can withdraw fees");
  480. pulse.withdrawFees(1 ether);
  481. }
  482. function testWithdrawFeesInsufficientBalance() public {
  483. vm.prank(admin);
  484. vm.expectRevert("Insufficient balance");
  485. pulse.withdrawFees(1 ether);
  486. }
  487. function testSetAndWithdrawAsFeeManager() public {
  488. address feeManager = address(0x789);
  489. vm.prank(defaultProvider);
  490. pulse.setFeeManager(feeManager);
  491. // Setup: Request price update to accrue some fees
  492. bytes32[] memory priceIds = createPriceIds();
  493. vm.deal(address(consumer), 1 gwei);
  494. vm.prank(address(consumer));
  495. pulse.requestPriceUpdatesWithCallback{value: calculateTotalFee()}(
  496. block.timestamp,
  497. priceIds,
  498. CALLBACK_GAS_LIMIT
  499. );
  500. // Get provider's accrued fees instead of total fees
  501. PulseState.ProviderInfo memory providerInfo = pulse.getProviderInfo(
  502. defaultProvider
  503. );
  504. uint128 providerAccruedFees = providerInfo.accruedFeesInWei;
  505. uint256 managerBalanceBefore = feeManager.balance;
  506. vm.prank(feeManager);
  507. pulse.withdrawAsFeeManager(defaultProvider, providerAccruedFees);
  508. assertEq(
  509. feeManager.balance,
  510. managerBalanceBefore + providerAccruedFees,
  511. "Fee manager balance should increase by withdrawn amount"
  512. );
  513. providerInfo = pulse.getProviderInfo(defaultProvider);
  514. assertEq(
  515. providerInfo.accruedFeesInWei,
  516. 0,
  517. "Provider should have no fees after withdrawal"
  518. );
  519. }
  520. function testSetFeeManagerUnauthorized() public {
  521. address feeManager = address(0x789);
  522. vm.prank(address(0xdead));
  523. vm.expectRevert("Provider not registered");
  524. pulse.setFeeManager(feeManager);
  525. }
  526. function testWithdrawAsFeeManagerUnauthorized() public {
  527. vm.prank(address(0xdead));
  528. vm.expectRevert("Only fee manager");
  529. pulse.withdrawAsFeeManager(defaultProvider, 1 ether);
  530. }
  531. function testWithdrawAsFeeManagerInsufficientBalance() public {
  532. // Set up fee manager first
  533. address feeManager = address(0x789);
  534. vm.prank(defaultProvider);
  535. pulse.setFeeManager(feeManager);
  536. vm.prank(feeManager);
  537. vm.expectRevert("Insufficient balance");
  538. pulse.withdrawAsFeeManager(defaultProvider, 1 ether);
  539. }
  540. // Add new test for invalid priceIds
  541. function testExecuteCallbackWithInvalidPriceIds() public {
  542. bytes32[] memory priceIds = createPriceIds();
  543. uint256 publishTime = block.timestamp;
  544. // Setup request
  545. (uint64 sequenceNumber, , ) = setupConsumerRequest(address(consumer));
  546. // Create different priceIds
  547. bytes32[] memory wrongPriceIds = new bytes32[](2);
  548. wrongPriceIds[0] = bytes32(uint256(1)); // Different price IDs
  549. wrongPriceIds[1] = bytes32(uint256(2));
  550. PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
  551. publishTime
  552. );
  553. mockParsePriceFeedUpdates(priceFeeds);
  554. bytes[] memory updateData = createMockUpdateData(priceFeeds);
  555. // Should revert when trying to execute with wrong priceIds
  556. vm.prank(defaultProvider);
  557. vm.expectRevert(
  558. abi.encodeWithSelector(
  559. InvalidPriceIds.selector,
  560. wrongPriceIds[0],
  561. priceIds[0]
  562. )
  563. );
  564. pulse.executeCallback(sequenceNumber, updateData, wrongPriceIds);
  565. }
  566. function testRevertOnTooManyPriceIds() public {
  567. uint256 maxPriceIds = uint256(pulse.MAX_PRICE_IDS());
  568. // Create array with MAX_PRICE_IDS + 1 price IDs
  569. bytes32[] memory priceIds = new bytes32[](maxPriceIds + 1);
  570. for (uint i = 0; i < priceIds.length; i++) {
  571. priceIds[i] = bytes32(uint256(i + 1));
  572. }
  573. vm.deal(address(consumer), 1 gwei);
  574. uint128 totalFee = calculateTotalFee();
  575. vm.prank(address(consumer));
  576. vm.expectRevert(
  577. abi.encodeWithSelector(
  578. TooManyPriceIds.selector,
  579. maxPriceIds + 1,
  580. maxPriceIds
  581. )
  582. );
  583. pulse.requestPriceUpdatesWithCallback{value: totalFee}(
  584. block.timestamp,
  585. priceIds,
  586. CALLBACK_GAS_LIMIT
  587. );
  588. }
  589. function testProviderRegistration() public {
  590. address provider = address(0x123);
  591. uint128 providerFee = 1000;
  592. vm.prank(provider);
  593. pulse.registerProvider(providerFee);
  594. PulseState.ProviderInfo memory info = pulse.getProviderInfo(provider);
  595. assertEq(info.feeInWei, providerFee);
  596. assertTrue(info.isRegistered);
  597. }
  598. function testSetProviderFee() public {
  599. address provider = address(0x123);
  600. uint128 initialFee = 1000;
  601. uint128 newFee = 2000;
  602. vm.prank(provider);
  603. pulse.registerProvider(initialFee);
  604. vm.prank(provider);
  605. pulse.setProviderFee(newFee);
  606. PulseState.ProviderInfo memory info = pulse.getProviderInfo(provider);
  607. assertEq(info.feeInWei, newFee);
  608. }
  609. function testDefaultProvider() public {
  610. address provider = address(0x123);
  611. uint128 providerFee = 1000;
  612. vm.prank(provider);
  613. pulse.registerProvider(providerFee);
  614. vm.prank(admin);
  615. pulse.setDefaultProvider(provider);
  616. assertEq(pulse.getDefaultProvider(), provider);
  617. }
  618. function testRequestWithProvider() public {
  619. address provider = address(0x123);
  620. uint128 providerFee = 1000;
  621. vm.prank(provider);
  622. pulse.registerProvider(providerFee);
  623. vm.prank(admin);
  624. pulse.setDefaultProvider(provider);
  625. bytes32[] memory priceIds = new bytes32[](1);
  626. priceIds[0] = bytes32(uint256(1));
  627. uint128 totalFee = pulse.getFee(CALLBACK_GAS_LIMIT);
  628. vm.deal(address(consumer), totalFee);
  629. vm.prank(address(consumer));
  630. uint64 sequenceNumber = pulse.requestPriceUpdatesWithCallback{
  631. value: totalFee
  632. }(block.timestamp, priceIds, CALLBACK_GAS_LIMIT);
  633. PulseState.Request memory req = pulse.getRequest(sequenceNumber);
  634. assertEq(req.provider, provider);
  635. }
  636. function testExclusivityPeriod() public {
  637. // Test initial value
  638. assertEq(
  639. pulse.getExclusivityPeriod(),
  640. 15,
  641. "Initial exclusivity period should be 15 seconds"
  642. );
  643. // Test setting new value
  644. vm.prank(admin);
  645. vm.expectEmit();
  646. emit ExclusivityPeriodUpdated(15, 30);
  647. pulse.setExclusivityPeriod(30);
  648. assertEq(
  649. pulse.getExclusivityPeriod(),
  650. 30,
  651. "Exclusivity period should be updated"
  652. );
  653. }
  654. function testSetExclusivityPeriodUnauthorized() public {
  655. vm.prank(address(0xdead));
  656. vm.expectRevert("Only admin can set exclusivity period");
  657. pulse.setExclusivityPeriod(30);
  658. }
  659. function testExecuteCallbackDuringExclusivity() public {
  660. // Register a second provider
  661. address secondProvider = address(0x456);
  662. vm.prank(secondProvider);
  663. pulse.registerProvider(DEFAULT_PROVIDER_FEE);
  664. // Setup request
  665. (
  666. uint64 sequenceNumber,
  667. bytes32[] memory priceIds,
  668. uint256 publishTime
  669. ) = setupConsumerRequest(address(consumer));
  670. // Setup mock data
  671. PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
  672. publishTime
  673. );
  674. mockParsePriceFeedUpdates(priceFeeds);
  675. bytes[] memory updateData = createMockUpdateData(priceFeeds);
  676. // Try to execute with second provider during exclusivity period
  677. vm.prank(secondProvider);
  678. vm.expectRevert("Only assigned provider during exclusivity period");
  679. pulse.executeCallback(sequenceNumber, updateData, priceIds);
  680. // Original provider should succeed
  681. vm.prank(defaultProvider);
  682. pulse.executeCallback(sequenceNumber, updateData, priceIds);
  683. }
  684. function testExecuteCallbackAfterExclusivity() public {
  685. // Register a second provider
  686. address secondProvider = address(0x456);
  687. vm.prank(secondProvider);
  688. pulse.registerProvider(DEFAULT_PROVIDER_FEE);
  689. // Setup request
  690. (
  691. uint64 sequenceNumber,
  692. bytes32[] memory priceIds,
  693. uint256 publishTime
  694. ) = setupConsumerRequest(address(consumer));
  695. // Setup mock data
  696. PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
  697. publishTime
  698. );
  699. mockParsePriceFeedUpdates(priceFeeds);
  700. bytes[] memory updateData = createMockUpdateData(priceFeeds);
  701. // Wait for exclusivity period to end
  702. vm.warp(block.timestamp + pulse.getExclusivityPeriod() + 1);
  703. // Second provider should now succeed
  704. vm.prank(secondProvider);
  705. pulse.executeCallback(sequenceNumber, updateData, priceIds);
  706. }
  707. function testExecuteCallbackWithCustomExclusivityPeriod() public {
  708. // Register a second provider
  709. address secondProvider = address(0x456);
  710. vm.prank(secondProvider);
  711. pulse.registerProvider(DEFAULT_PROVIDER_FEE);
  712. // Set custom exclusivity period
  713. vm.prank(admin);
  714. pulse.setExclusivityPeriod(30);
  715. // Setup request
  716. (
  717. uint64 sequenceNumber,
  718. bytes32[] memory priceIds,
  719. uint256 publishTime
  720. ) = setupConsumerRequest(address(consumer));
  721. // Setup mock data
  722. PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
  723. publishTime
  724. );
  725. mockParsePriceFeedUpdates(priceFeeds);
  726. bytes[] memory updateData = createMockUpdateData(priceFeeds);
  727. // Try at 29 seconds (should fail for second provider)
  728. vm.warp(block.timestamp + 29);
  729. vm.prank(secondProvider);
  730. vm.expectRevert("Only assigned provider during exclusivity period");
  731. pulse.executeCallback(sequenceNumber, updateData, priceIds);
  732. // Try at 31 seconds (should succeed for second provider)
  733. vm.warp(block.timestamp + 2);
  734. vm.prank(secondProvider);
  735. pulse.executeCallback(sequenceNumber, updateData, priceIds);
  736. }
  737. function testGetFirstActiveRequests() public {
  738. // Setup test data
  739. (
  740. bytes32[] memory priceIds,
  741. bytes[] memory updateData
  742. ) = setupTestData();
  743. createTestRequests(priceIds);
  744. completeRequests(updateData, priceIds);
  745. testRequestScenarios(priceIds, updateData);
  746. }
  747. function setupTestData()
  748. private
  749. pure
  750. returns (bytes32[] memory, bytes[] memory)
  751. {
  752. bytes32[] memory priceIds = new bytes32[](1);
  753. priceIds[0] = bytes32(uint256(1));
  754. bytes[] memory updateData = new bytes[](1);
  755. return (priceIds, updateData);
  756. }
  757. function createTestRequests(bytes32[] memory priceIds) private {
  758. uint256 publishTime = block.timestamp;
  759. for (uint i = 0; i < 5; i++) {
  760. vm.deal(address(this), 1 ether);
  761. pulse.requestPriceUpdatesWithCallback{value: 1 ether}(
  762. publishTime,
  763. priceIds,
  764. 1000000
  765. );
  766. }
  767. }
  768. function completeRequests(
  769. bytes[] memory updateData,
  770. bytes32[] memory priceIds
  771. ) private {
  772. // Create mock price feeds and setup Pyth response
  773. PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
  774. block.timestamp
  775. );
  776. mockParsePriceFeedUpdates(priceFeeds);
  777. updateData = createMockUpdateData(priceFeeds);
  778. vm.deal(defaultProvider, 2 ether); // Increase ETH allocation to prevent OutOfFunds
  779. vm.startPrank(defaultProvider);
  780. pulse.executeCallback{value: 1 ether}(2, updateData, priceIds);
  781. pulse.executeCallback{value: 1 ether}(4, updateData, priceIds);
  782. vm.stopPrank();
  783. }
  784. function testRequestScenarios(
  785. bytes32[] memory priceIds,
  786. bytes[] memory updateData
  787. ) private {
  788. // Test 1: Request more than available
  789. checkMoreThanAvailable();
  790. // Test 2: Request exact number
  791. checkExactNumber();
  792. // Test 3: Request fewer than available
  793. checkFewerThanAvailable();
  794. // Test 4: Request zero
  795. checkZeroRequest();
  796. // Test 5: Clear all and check empty
  797. clearAllRequests(updateData, priceIds);
  798. checkEmptyState();
  799. }
  800. // Split test scenarios into separate functions
  801. function checkMoreThanAvailable() private {
  802. (PulseState.Request[] memory requests, uint256 count) = pulse
  803. .getFirstActiveRequests(10);
  804. assertEq(count, 3, "Should find 3 active requests");
  805. assertEq(requests.length, 3, "Array should be resized to 3");
  806. assertEq(
  807. requests[0].sequenceNumber,
  808. 1,
  809. "First request should be oldest"
  810. );
  811. assertEq(requests[1].sequenceNumber, 3, "Second request should be #3");
  812. assertEq(requests[2].sequenceNumber, 5, "Third request should be #5");
  813. }
  814. function checkExactNumber() private {
  815. (PulseState.Request[] memory requests, uint256 count) = pulse
  816. .getFirstActiveRequests(3);
  817. assertEq(count, 3, "Should find 3 active requests");
  818. assertEq(requests.length, 3, "Array should match requested size");
  819. }
  820. function checkFewerThanAvailable() private {
  821. (PulseState.Request[] memory requests, uint256 count) = pulse
  822. .getFirstActiveRequests(2);
  823. assertEq(count, 2, "Should find 2 active requests");
  824. assertEq(requests.length, 2, "Array should match requested size");
  825. assertEq(
  826. requests[0].sequenceNumber,
  827. 1,
  828. "First request should be oldest"
  829. );
  830. assertEq(requests[1].sequenceNumber, 3, "Second request should be #3");
  831. }
  832. function checkZeroRequest() private {
  833. (PulseState.Request[] memory requests, uint256 count) = pulse
  834. .getFirstActiveRequests(0);
  835. assertEq(count, 0, "Should find 0 active requests");
  836. assertEq(requests.length, 0, "Array should be empty");
  837. }
  838. function clearAllRequests(
  839. bytes[] memory updateData,
  840. bytes32[] memory priceIds
  841. ) private {
  842. vm.deal(defaultProvider, 3 ether); // Increase ETH allocation
  843. vm.startPrank(defaultProvider);
  844. pulse.executeCallback{value: 1 ether}(1, updateData, priceIds);
  845. pulse.executeCallback{value: 1 ether}(3, updateData, priceIds);
  846. pulse.executeCallback{value: 1 ether}(5, updateData, priceIds);
  847. vm.stopPrank();
  848. }
  849. function checkEmptyState() private {
  850. (PulseState.Request[] memory requests, uint256 count) = pulse
  851. .getFirstActiveRequests(10);
  852. assertEq(count, 0, "Should find 0 active requests");
  853. assertEq(requests.length, 0, "Array should be empty");
  854. }
  855. function testGetFirstActiveRequestsGasUsage() public {
  856. // Setup test data
  857. bytes32[] memory priceIds = new bytes32[](1);
  858. priceIds[0] = bytes32(uint256(1));
  859. uint256 publishTime = block.timestamp;
  860. uint256 callbackGasLimit = 1000000;
  861. // Create mock price feeds and setup Pyth response
  862. PythStructs.PriceFeed[] memory priceFeeds = createMockPriceFeeds(
  863. publishTime
  864. );
  865. mockParsePriceFeedUpdates(priceFeeds);
  866. bytes[] memory updateData = createMockUpdateData(priceFeeds);
  867. // Create 20 requests with some gaps
  868. for (uint i = 0; i < 20; i++) {
  869. vm.deal(address(this), 1 ether);
  870. pulse.requestPriceUpdatesWithCallback{value: 1 ether}(
  871. publishTime,
  872. priceIds,
  873. callbackGasLimit
  874. );
  875. // Complete every third request to create gaps
  876. if (i % 3 == 0) {
  877. vm.deal(defaultProvider, 1 ether);
  878. vm.prank(defaultProvider);
  879. pulse.executeCallback{value: 1 ether}(
  880. uint64(i + 1),
  881. updateData,
  882. priceIds
  883. );
  884. }
  885. }
  886. // Measure gas for different request counts
  887. uint256 gas1 = gasleft();
  888. pulse.getFirstActiveRequests(5);
  889. uint256 gas1Used = gas1 - gasleft();
  890. uint256 gas2 = gasleft();
  891. pulse.getFirstActiveRequests(10);
  892. uint256 gas2Used = gas2 - gasleft();
  893. // Log gas usage for analysis
  894. emit log_named_uint("Gas used for 5 requests", gas1Used);
  895. emit log_named_uint("Gas used for 10 requests", gas2Used);
  896. // Verify gas usage scales roughly linearly
  897. // Allow 10% margin for other factors
  898. assertApproxEqRel(
  899. gas2Used,
  900. gas1Used * 2,
  901. 0.1e18, // 10% tolerance
  902. "Gas usage should scale roughly linearly"
  903. );
  904. }
  905. // Mock implementation of pulseCallback
  906. function pulseCallback(
  907. uint64 sequenceNumber,
  908. PythStructs.PriceFeed[] memory priceFeeds
  909. ) external override {
  910. // Just accept the callback, no need to do anything with the data
  911. // This prevents the revert we're seeing
  912. }
  913. }