Implement the new IPyth events and methods (#241)

* Implement the new IPyth events and methods

* Check contracts gets the fees in tests

* Fix the fee variable position to avoid conflict

* Add migration files.

* Add events to migration names and docs

* Fix pyth contract address in tests

Very strangely after adding migration steps the old address
used in evm relay became wormhole implementation address
I looked at eth-0/tests container logs and saw the
address is entirely different (before and after the change)

* Fix previous migration bug.

* rename instance to proxy to be more clear

* Update Deploying.md

Author: ali-behjati

devnet/p2w-evm-relay.yaml

@@ -64,7 +64,7 @@ spec:
             - name: EVM_HDWALLET_PATH
               value: "m/44'/60'/0'/0/1" # Use account with idx 1
             - name: EVM_PYTH_CONTRACT_ADDRESS
-              value: "0xDb56f2e9369E0D7bD191099125a3f6C370F8ed15"
+              value: "0xe982E462b094850F12AF94d21D470e21bE9D0E9C"
             - name: EVM_VERIFY_PRICE_FEEDS
               value: "yes"
             - name: REST_PORT

devnet/pyth-evm-watcher.yaml

@@ -24,4 +24,4 @@ spec:
             - name: WS_ENDPOINT
               value: 'ws://eth-devnet:8545'
             - name: PYTH_CONTRACT
-              value: '0xDb56f2e9369E0D7bD191099125a3f6C370F8ed15'
+              value: '0xe982E462b094850F12AF94d21D470e21bE9D0E9C'

ethereum/Deploying.md

@@ -48,7 +48,7 @@ for more information.
 Changes to the files in this directory should be commited as well.
 
 # Upgrading the contract
-To upgrade the contract you should add a new migration file in the `migrations/prod` directory increasing the migration number.
+To upgrade the contract you should add a new migration file in the `migrations/*` directories increasing the migration number.
 
 It looks like so:
 
@@ -63,8 +63,8 @@ const { upgradeProxy } = require("@openzeppelin/truffle-upgrades");
  * Briefly describe the changelog here.
  */
 module.exports = async function (deployer) {
-    const instance = await PythUpgradable.deployed();
-    await upgradeProxy(instance.address, PythUpgradable, { deployer });
+    const proxy = await PythUpgradable.deployed();
+    await upgradeProxy(proxy.address, PythUpgradable, { deployer });
 }
 ```
 

ethereum/contracts/pyth/Pyth.sol

@@ -24,32 +24,51 @@ abstract contract Pyth is PythGetters, PythSetters, AbstractPyth {
         setPyth2WormholeEmitter(pyth2WormholeEmitter);
     }
 
-    function updatePriceBatchFromVm(bytes memory encodedVm) public returns (PythInternalStructs.BatchPriceAttestation memory bpa) {
+    function updatePriceBatchFromVm(bytes memory encodedVm) private returns (PythInternalStructs.BatchPriceAttestation memory bpa) {
         (IWormhole.VM memory vm, bool valid, string memory reason) = wormhole().parseAndVerifyVM(encodedVm);
 
         require(valid, reason);
         require(verifyPythVM(vm), "invalid data source chain/emitter ID");
 
         PythInternalStructs.BatchPriceAttestation memory batch = parseBatchPriceAttestation(vm.payload);
 
+        uint freshPrices = 0;
+
         for (uint i = 0; i < batch.attestations.length; i++) {
             PythInternalStructs.PriceAttestation memory attestation = batch.attestations[i];
 
             PythInternalStructs.PriceInfo memory latestPrice = latestPriceInfo(attestation.priceId);
 
+            bool fresh = false;
             if(attestation.attestationTime > latestPrice.attestationTime) {
+                freshPrices += 1;
+                fresh = true;
                 setLatestPriceInfo(attestation.priceId, newPriceInfo(attestation));
-                emit PriceUpdate(attestation.priceId, attestation.publishTime);
             }
+
+            emit PriceFeedUpdate(attestation.priceId, fresh, vm.emitterChainId, vm.sequence, latestPrice.priceFeed.publishTime,
+                attestation.publishTime, attestation.price, attestation.conf);
         }
 
+        emit BatchPriceFeedUpdate(vm.emitterChainId, vm.sequence, batch.attestations.length, freshPrices);
+
         return batch;
     }
 
-    function updatePriceFeeds(bytes[] calldata updateData) public override {
+    function updatePriceFeeds(bytes[] calldata updateData) public override payable {
+        uint requiredFee = getUpdateFee(updateData.length);
+        require(msg.value >= requiredFee, "Insufficient paid fee amount");
+        payable(msg.sender).transfer(msg.value - requiredFee);
+ 
         for(uint i = 0; i < updateData.length; i++) {
             updatePriceBatchFromVm(updateData[i]);
         }
+
+        emit UpdatePriceFeeds(msg.sender, updateData.length, requiredFee);
+    }
+
+    function getUpdateFee(uint updateDataSize) public override view returns (uint feeAmount) {
+        return singleUpdateFeeInWei() * updateDataSize;
     }
 
     function newPriceInfo(PythInternalStructs.PriceAttestation memory pa) private view returns (PythInternalStructs.PriceInfo memory info) {

ethereum/contracts/pyth/PythGetters.sol

@@ -34,4 +34,9 @@ contract PythGetters is PythState {
     function validDataSources() public view returns (PythInternalStructs.DataSource[] memory) {
         return _state.validDataSources;
     }
+
+
+    function singleUpdateFeeInWei() public view returns (uint) {
+        return _state.singleUpdateFeeInWei;
+    }
 }

ethereum/contracts/pyth/PythSetters.sol

@@ -21,4 +21,8 @@ contract PythSetters is PythState {
     function setLatestPriceInfo(bytes32 priceId, PythInternalStructs.PriceInfo memory info) internal {
         _state.latestPriceInfo[priceId] = info;
     }
+
+    function setSingleUpdateFeeInWei(uint fee) internal {
+        _state.singleUpdateFeeInWei = fee;
+    }
 }

ethereum/contracts/pyth/PythState.sol

@@ -21,6 +21,8 @@ contract PythStorage {
         // (chainId, emitterAddress) => isValid; takes advantage of
         // constant-time mapping lookup for VM verification
         mapping(bytes32 => bool) isValidDataSource;
+
+        uint singleUpdateFeeInWei;
     }
 }
 

ethereum/contracts/pyth/PythUpgradable.sol

@@ -55,6 +55,11 @@ contract PythUpgradable is Initializable, OwnableUpgradeable, UUPSUpgradeable, P
         }
     }
 
+    /// Privileged function to update the price update fee
+    function updateSingleUpdateFeeInWei(uint newFee) onlyOwner public {
+        PythSetters.setSingleUpdateFeeInWei(newFee);
+    }
+
     /// Ensures the contract cannot be uninitialized and taken over.
     /// @custom:oz-upgrades-unsafe-allow constructor
     constructor() initializer {}

ethereum/migrations/prod-receiver/4_pyth_multiple_emitters.js

@@ -8,9 +8,10 @@ const { upgradeProxy } = require("@openzeppelin/truffle-upgrades");
  * Adds multiple emitter/chain ID support
  */
 module.exports = async function (deployer) {
-    const instance = await PythUpgradable.deployed();
-    await instance.addDataSource(
-        instance.pyth2WormholeChainId(),
-        instance.pyth2WormholeEmitter()
+    const proxy = await PythUpgradable.deployed();
+    await upgradeProxy(proxy.address, PythUpgradable, { deployer });
+    await proxy.addDataSource(
+        proxy.pyth2WormholeChainId(),
+        proxy.pyth2WormholeEmitter()
     );
 };

ethereum/migrations/prod-receiver/5_pyth_add_events_and_update_fee.js

@@ -0,0 +1,16 @@
+require('dotenv').config({ path: "../.env" });
+
+const PythUpgradable = artifacts.require("PythUpgradable");
+
+const { upgradeProxy } = require("@openzeppelin/truffle-upgrades");
+
+/**
+ * This change:
+ * - Adds fee for updating prices. Default value in Ethereum is 0, so the value after upgrade will be 0.
+ * - Emits multiple events when a price gets updated. This can be used by off-chain applications to monitor
+ *   the contract activity.
+ */
+module.exports = async function (deployer) {
+    const proxy = await PythUpgradable.deployed();
+    await upgradeProxy(proxy.address, PythUpgradable, { deployer });
+}