feat: update parseTwapPriceFeedUpdates function to accept a single array of price update data

cctdaniel · cctdaniel · commit c88c2f5fddd6 · 2025-04-09T21:42:34.000+09:00
diff --git a/target_chains/ethereum/contracts/contracts/pyth/Pyth.sol b/target_chains/ethereum/contracts/contracts/pyth/Pyth.sol
@@ -362,7 +362,7 @@ abstract contract Pyth is
     }
 
     function parseTwapPriceFeedUpdates(
-        bytes[][] calldata updateData,
+        bytes[] calldata updateData,
         bytes32[] calldata priceIds
     )
         external
@@ -375,24 +375,19 @@ abstract contract Pyth is
         if (updateData.length != 2) {
             revert PythErrors.InvalidUpdateData();
         }
-        // We only charge fee for 1 update even though we need 2 updates to derive TWAP.
-        // This is for better UX since user's intention is to get a single TWAP price.
-        uint requiredFee = getUpdateFee(updateData[0]);
 
-        if (requiredFee != getUpdateFee(updateData[1])) {
-            revert PythErrors.InvalidUpdateData();
-        }
+        uint requiredFee = getUpdateFee(updateData);
         if (msg.value < requiredFee) revert PythErrors.InsufficientFee();
 
         unchecked {
             twapPriceFeeds = new PythStructs.TwapPriceFeed[](priceIds.length);
-            for (uint i = 0; i < updateData[0].length; i++) {
+            for (uint i = 0; i < updateData.length - 1; i++) {
                 if (
-                    (updateData[0][i].length > 4 &&
-                        UnsafeCalldataBytesLib.toUint32(updateData[0][i], 0) ==
+                    (updateData[i].length > 4 &&
+                        UnsafeCalldataBytesLib.toUint32(updateData[i], 0) ==
                         ACCUMULATOR_MAGIC) &&
-                    (updateData[1][i].length > 4 &&
-                        UnsafeCalldataBytesLib.toUint32(updateData[1][i], 0) ==
+                    (updateData[i + 1].length > 4 &&
+                        UnsafeCalldataBytesLib.toUint32(updateData[i + 1], 0) ==
                         ACCUMULATOR_MAGIC)
                 ) {
                     uint offsetStart;
@@ -405,19 +400,16 @@ abstract contract Pyth is
                         offsetStart,
                         twapPriceInfoStart,
                         priceIdStart
-                    ) = processSingleTwapUpdate(updateData[0][i]);
+                    ) = processSingleTwapUpdate(updateData[i]);
                     (
                         offsetEnd,
                         twapPriceInfoEnd,
                         priceIdEnd
-                    ) = processSingleTwapUpdate(updateData[1][i]);
+                    ) = processSingleTwapUpdate(updateData[i + 1]);
 
                     if (priceIdStart != priceIdEnd)
                         revert PythErrors.InvalidTwapUpdateDataSet();
 
-                    // Perform additional validation checks on the TWAP price data
-                    // to ensure proper time ordering, consistent exponents, and timestamp integrity
-                    // before using the data for calculations
                     validateTwapPriceInfo(twapPriceInfoStart, twapPriceInfoEnd);
 
                     uint k = findIndexOfPriceId(priceIds, priceIdStart);
diff --git a/target_chains/ethereum/contracts/forge-test/Pyth.t.sol b/target_chains/ethereum/contracts/forge-test/Pyth.t.sol
@@ -11,6 +11,7 @@ import "@pythnetwork/pyth-sdk-solidity/PythStructs.sol";
 import "./utils/WormholeTestUtils.t.sol";
 import "./utils/PythTestUtils.t.sol";
 import "./utils/RandTestUtils.t.sol";
+import "forge-std/console.sol";
 
 contract PythTest is Test, WormholeTestUtils, PythTestUtils {
     IPyth public pyth;
@@ -105,7 +106,7 @@ contract PythTest is Test, WormholeTestUtils, PythTestUtils {
     function createBatchedTwapUpdateDataFromMessagesWithConfig(
         PriceFeedMessage[] memory messages,
         MerkleUpdateConfig memory config
-    ) public returns (bytes[][] memory updateData, uint updateFee) {
+    ) public returns (bytes[] memory updateData, uint updateFee) {
         require(messages.length >= 2, "At least 2 messages required for TWAP");
 
         // Create TWAP messages from regular price feed messages
@@ -140,33 +141,24 @@ contract PythTest is Test, WormholeTestUtils, PythTestUtils {
         endTwapMessages[0].prevPublishTime = messages[1].prevPublishTime;
         endTwapMessages[0].publishSlot = 1100; // End slot (100 slots after start)
 
-        // Generate the update data for start and end using the TWAP-specific function
-        bytes[] memory startUpdateData = new bytes[](1);
-        startUpdateData[0] = generateWhMerkleTwapUpdateWithSource(
+        // Create the updateData array with exactly 2 elements as required by parseTwapPriceFeedUpdates
+        updateData = new bytes[](2);
+        updateData[0] = generateWhMerkleTwapUpdateWithSource(
             startTwapMessages,
             config
         );
-
-        bytes[] memory endUpdateData = new bytes[](1);
-        endUpdateData[0] = generateWhMerkleTwapUpdateWithSource(
+        updateData[1] = generateWhMerkleTwapUpdateWithSource(
             endTwapMessages,
             config
         );
 
-        // Create the updateData array with exactly 2 elements as required by parseTwapPriceFeedUpdates
-        updateData = new bytes[][](2);
-        updateData[0] = startUpdateData;
-        updateData[1] = endUpdateData;
-
         // Calculate the update fee
-        // We only charge fee for 1 update even though we need 2 updates to derive TWAP.
-        // This is for better UX since user's intention is to get a single TWAP price.
-        updateFee = pyth.getUpdateFee(updateData[0]);
+        updateFee = pyth.getUpdateFee(updateData);
     }
 
     function createBatchedTwapUpdateDataFromMessages(
         PriceFeedMessage[] memory messages
-    ) internal returns (bytes[][] memory updateData, uint updateFee) {
+    ) internal returns (bytes[] memory updateData, uint updateFee) {
         (
             updateData,
             updateFee
@@ -423,7 +415,7 @@ contract PythTest is Test, WormholeTestUtils, PythTestUtils {
 
         // Create update data for TWAP calculation
         (
-            bytes[][] memory updateData,
+            bytes[] memory updateData,
             uint updateFee
         ) = createBatchedTwapUpdateDataFromMessages(messages);
 
@@ -461,8 +453,8 @@ contract PythTest is Test, WormholeTestUtils, PythTestUtils {
         priceIds[0] = bytes32(uint256(1));
 
         // Create invalid update data with wrong length
-        bytes[][] memory updateData = new bytes[][](1); // Should be 2
-        updateData[0] = new bytes[](1);
+        bytes[] memory updateData = new bytes[](1); // Should be 2
+        updateData[0] = new bytes(1);
 
         vm.expectRevert(PythErrors.InvalidUpdateData.selector);
         pyth.parseTwapPriceFeedUpdates{value: 0}(updateData, priceIds);
@@ -489,7 +481,7 @@ contract PythTest is Test, WormholeTestUtils, PythTestUtils {
         messages[1].prevPublishTime = 1000;
 
         (
-            bytes[][] memory updateData,
+            bytes[] memory updateData,
             uint updateFee
         ) = createBatchedTwapUpdateDataFromMessages(messages);
 
@@ -518,7 +510,7 @@ contract PythTest is Test, WormholeTestUtils, PythTestUtils {
         messages[1].prevPublishTime = 900;
 
         (
-            bytes[][] memory updateData,
+            bytes[] memory updateData,
             uint updateFee
         ) = createBatchedTwapUpdateDataFromMessages(messages);
 
@@ -549,7 +541,7 @@ contract PythTest is Test, WormholeTestUtils, PythTestUtils {
         messages[1].prevPublishTime = 1000;
 
         (
-            bytes[][] memory updateData,
+            bytes[] memory updateData,
             uint updateFee
         ) = createBatchedTwapUpdateDataFromMessages(messages);
 
@@ -578,7 +570,7 @@ contract PythTest is Test, WormholeTestUtils, PythTestUtils {
         messages[1].prevPublishTime = 1000;
 
         (
-            bytes[][] memory updateData,
+            bytes[] memory updateData,
             uint updateFee
         ) = createBatchedTwapUpdateDataFromMessages(messages);
 
@@ -603,7 +595,7 @@ contract PythTest is Test, WormholeTestUtils, PythTestUtils {
         messages[1].prevPublishTime = 1000;
 
         (
-            bytes[][] memory updateData,
+            bytes[] memory updateData,
             uint updateFee
         ) = createBatchedTwapUpdateDataFromMessages(messages);
 
diff --git a/target_chains/ethereum/sdk/solidity/AbstractPyth.sol b/target_chains/ethereum/sdk/solidity/AbstractPyth.sol
@@ -135,4 +135,14 @@ abstract contract AbstractPyth is IPyth {
         virtual
         override
         returns (PythStructs.PriceFeed[] memory priceFeeds);
+
+    function parseTwapPriceFeedUpdates(
+        bytes[] calldata updateData,
+        bytes32[] calldata priceIds
+    )
+        external
+        payable
+        virtual
+        override
+        returns (PythStructs.TwapPriceFeed[] memory twapPriceFeeds);
 }
diff --git a/target_chains/ethereum/sdk/solidity/IPyth.sol b/target_chains/ethereum/sdk/solidity/IPyth.sol
@@ -119,26 +119,26 @@ interface IPyth is IPythEvents {
         uint64 maxPublishTime
     ) external payable returns (PythStructs.PriceFeed[] memory priceFeeds);
 
-    /// @notice Parse time-weighted average price (TWAP) from two sets of price update data for the given `priceIds`.
+    /// @notice Parse time-weighted average price (TWAP) from two consecutive price updates for the given `priceIds`.
     ///
     /// This method calculates TWAP between two data points by processing the difference in cumulative price values
-    /// divided by the time period. It requires two sets of update data that contain valid price information
+    /// divided by the time period. It requires exactly two updates that contain valid price information
     /// for all the requested price IDs.
     ///
     /// This method requires the caller to pay a fee in wei; the required fee can be computed by calling
-    /// `getUpdateFee` with the length of either updateData array (both arrays must have the same length).
+    /// `getUpdateFee` with the updateData array.
     ///
     /// @dev Reverts if:
     /// - The transferred fee is not sufficient
     /// - The updateData is invalid or malformed
+    /// - The updateData array does not contain exactly 2 updates
     /// - There is no update for any of the given `priceIds`
-    /// - The two update datasets are not comparable (different number of updates or mismatched price IDs)
     /// - The time ordering between data points is invalid (start time must be before end time)
-    /// @param updateData Array containing two arrays of price update data (start and end points for TWAP calculation)
+    /// @param updateData Array containing exactly two price updates (start and end points for TWAP calculation)
     /// @param priceIds Array of price ids to calculate TWAP for
     /// @return twapPriceFeeds Array of TWAP price feeds corresponding to the given `priceIds` (with the same order)
     function parseTwapPriceFeedUpdates(
-        bytes[][] calldata updateData,
+        bytes[] calldata updateData,
         bytes32[] calldata priceIds
     )
         external
diff --git a/target_chains/ethereum/sdk/solidity/MockPyth.sol b/target_chains/ethereum/sdk/solidity/MockPyth.sol
@@ -162,7 +162,7 @@ contract MockPyth is AbstractPyth {
     }
 
     function parseTwapPriceFeedUpdates(
-        bytes[][] calldata updateData,
+        bytes[] calldata updateData,
         bytes32[] calldata priceIds
     )
         external
@@ -172,9 +172,7 @@ contract MockPyth is AbstractPyth {
         // Validate inputs and fee
         if (updateData.length != 2) revert PythErrors.InvalidUpdateData();
 
-        uint requiredFee = getUpdateFee(updateData[0]);
-        if (requiredFee != getUpdateFee(updateData[1]))
-            revert PythErrors.InvalidUpdateData();
+        uint requiredFee = getUpdateFee(updateData);
         if (msg.value < requiredFee) revert PythErrors.InsufficientFee();
 
         twapPriceFeeds = new PythStructs.TwapPriceFeed[](priceIds.length);
@@ -188,7 +186,7 @@ contract MockPyth is AbstractPyth {
     }
 
     function findPriceFeed(
-        bytes[][] calldata updateData,
+        bytes[] calldata updateData,
         bytes32 priceId,
         uint index
     )
@@ -200,21 +198,18 @@ contract MockPyth is AbstractPyth {
             bool found
         )
     {
-        for (uint j = 0; j < updateData[index].length; j++) {
-            (feed, prevPublishTime) = abi.decode(
-                updateData[index][j],
-                (PythStructs.PriceFeed, uint64)
-            );
+        (feed, prevPublishTime) = abi.decode(
+            updateData[index],
+            (PythStructs.PriceFeed, uint64)
+        );
 
-            if (feed.id == priceId) {
-                found = true;
-                break;
-            }
+        if (feed.id == priceId) {
+            found = true;
         }
     }
 
     function processTwapPriceFeed(
-        bytes[][] calldata updateData,
+        bytes[] calldata updateData,
         bytes32 priceId,
         uint index,
         PythStructs.TwapPriceFeed[] memory twapPriceFeeds
