From 24a08a06c556faa31a402ee173c18f986d7d9d81 Mon Sep 17 00:00:00 2001 From: Aditya Arora Date: Mon, 29 Apr 2024 12:42:30 -0400 Subject: [PATCH] chore(pricefeed-evm-sdk): Improve doc comments (#1521) --- target_chains/ethereum/sdk/solidity/MockPyth.sol | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/target_chains/ethereum/sdk/solidity/MockPyth.sol b/target_chains/ethereum/sdk/solidity/MockPyth.sol index 7c021702..dcb8d786 100644 --- a/target_chains/ethereum/sdk/solidity/MockPyth.sol +++ b/target_chains/ethereum/sdk/solidity/MockPyth.sol @@ -34,6 +34,18 @@ contract MockPyth is AbstractPyth { // Takes an array of encoded price feeds and stores them. // You can create this data either by calling createPriceFeedUpdateData or // by using web3.js or ethers abi utilities. + // @note: The updateData expected here is different from the one used in the main contract. + // In particular, the expected format is: + // [ + // abi.encode( + // PythStructs.PriceFeed( + // bytes32 id, + // PythStructs.Price price, + // PythStructs.Price emaPrice + // ), + // uint64 prevPublishTime + // ) + // ] function updatePriceFeeds( bytes[] calldata updateData ) public payable override {