chore(pricefeed-evm-sdk): Improve doc comments (#1521)

This commit is contained in:
Aditya Arora 2024-04-29 12:42:30 -04:00 committed by GitHub
parent f212907a8b
commit 24a08a06c5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 0 deletions

View File

@ -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 {