Merge pull request #88 from perpetual-protocol/release/v0.6.7

Release/v0.6.7

Author: tailingchen

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [0.6.7] - 2023-05-05
+- Add `IPriceFeedDispatcher.decimals` back for backward compatible.
+
+## [0.6.6] - 2023-05-05
+- Add `PriceFeedDispatcher.getPrice` for backward compatible.
+
 ## [0.6.5] - 2023-03-31
 - Refine natspec
 

contracts/ChainlinkPriceFeedV3.sol

@@ -5,12 +5,13 @@ import { Address } from "@openzeppelin/contracts/utils/Address.sol";
 import { SafeMath } from "@openzeppelin/contracts/math/SafeMath.sol";
 import { AggregatorV3Interface } from "@chainlink/contracts/src/v0.6/interfaces/AggregatorV3Interface.sol";
 import { IChainlinkPriceFeed } from "./interface/IChainlinkPriceFeed.sol";
+import { IPriceFeed } from "./interface/IPriceFeed.sol";
 import { IChainlinkPriceFeedV3 } from "./interface/IChainlinkPriceFeedV3.sol";
 import { IPriceFeedUpdate } from "./interface/IPriceFeedUpdate.sol";
 import { BlockContext } from "./base/BlockContext.sol";
 import { CachedTwap } from "./twap/CachedTwap.sol";
 
-contract ChainlinkPriceFeedV3 is IChainlinkPriceFeedV3, IPriceFeedUpdate, BlockContext, CachedTwap {
+contract ChainlinkPriceFeedV3 is IPriceFeed, IChainlinkPriceFeedV3, IPriceFeedUpdate, BlockContext, CachedTwap {
     using SafeMath for uint256;
     using Address for address;
 
@@ -75,7 +76,10 @@ contract ChainlinkPriceFeedV3 is IChainlinkPriceFeedV3, IPriceFeedUpdate, BlockC
         return _lastValidTimestamp;
     }
 
-    /// @inheritdoc IChainlinkPriceFeedV3
+    /// @inheritdoc IPriceFeed
+    /// @dev This is the view version of cacheTwap().
+    ///      If the interval is zero, returns the latest valid price.
+    ///         Else, returns TWAP calculating with the latest valid price and timestamp.
     function getPrice(uint256 interval) external view override returns (uint256) {
         (uint256 latestValidPrice, uint256 latestValidTime) = _getLatestOrCachedPrice();
 
@@ -115,7 +119,7 @@ contract ChainlinkPriceFeedV3 is IChainlinkPriceFeedV3, IPriceFeedUpdate, BlockC
         return _timeout;
     }
 
-    /// @inheritdoc IChainlinkPriceFeedV3
+    /// @inheritdoc IPriceFeed
     function decimals() external view override returns (uint8) {
         return _decimals;
     }

contracts/PriceFeedDispatcher.sol

@@ -6,11 +6,12 @@ import { SafeMath } from "@openzeppelin/contracts/math/SafeMath.sol";
 import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
 import { AggregatorV3Interface } from "@chainlink/contracts/src/v0.6/interfaces/AggregatorV3Interface.sol";
 import { BlockContext } from "./base/BlockContext.sol";
+import { IPriceFeed } from "./interface/IPriceFeed.sol";
 import { IPriceFeedDispatcher } from "./interface/IPriceFeedDispatcher.sol";
 import { UniswapV3PriceFeed } from "./UniswapV3PriceFeed.sol";
 import { ChainlinkPriceFeedV3 } from "./ChainlinkPriceFeedV3.sol";
 
-contract PriceFeedDispatcher is IPriceFeedDispatcher, Ownable, BlockContext {
+contract PriceFeedDispatcher is IPriceFeed, IPriceFeedDispatcher, Ownable, BlockContext {
     using SafeMath for uint256;
     using Address for address;
 
@@ -57,31 +58,43 @@ contract PriceFeedDispatcher is IPriceFeedDispatcher, Ownable, BlockContext {
     // EXTERNAL VIEW
     //
 
-    /// @inheritdoc IPriceFeedDispatcher
-    function getDispatchedPrice(uint256 interval) external view override returns (uint256) {
-        if (isToUseUniswapV3PriceFeed()) {
-            return _formatFromDecimalsToX10_18(_uniswapV3PriceFeed.getPrice(), _uniswapV3PriceFeed.decimals());
-        }
-
-        return _formatFromDecimalsToX10_18(_chainlinkPriceFeedV3.getPrice(interval), _chainlinkPriceFeedV3.decimals());
+    /// @inheritdoc IPriceFeed
+    function getPrice(uint256 interval) external view override returns (uint256) {
+        return getDispatchedPrice(interval);
     }
 
+    /// @inheritdoc IPriceFeedDispatcher
     function getChainlinkPriceFeedV3() external view override returns (address) {
         return address(_chainlinkPriceFeedV3);
     }
 
+    /// @inheritdoc IPriceFeedDispatcher
     function getUniswapV3PriceFeed() external view override returns (address) {
         return address(_uniswapV3PriceFeed);
     }
 
-    function decimals() external pure override returns (uint8) {
+    //
+    // EXTERNAL PURE
+    //
+
+    /// @inheritdoc IPriceFeed
+    function decimals() external pure override(IPriceFeed, IPriceFeedDispatcher) returns (uint8) {
         return _DECIMALS;
     }
 
     //
     // PUBLIC
     //
 
+    /// @inheritdoc IPriceFeedDispatcher
+    function getDispatchedPrice(uint256 interval) public view override returns (uint256) {
+        if (isToUseUniswapV3PriceFeed()) {
+            return _formatFromDecimalsToX10_18(_uniswapV3PriceFeed.getPrice(), _uniswapV3PriceFeed.decimals());
+        }
+
+        return _formatFromDecimalsToX10_18(_chainlinkPriceFeedV3.getPrice(interval), _chainlinkPriceFeedV3.decimals());
+    }
+
     function isToUseUniswapV3PriceFeed() public view returns (bool) {
         return
             address(_uniswapV3PriceFeed) != address(0) &&

contracts/interface/IChainlinkPriceFeedV3.sol

@@ -35,13 +35,6 @@ interface IChainlinkPriceFeedV3 is IChainlinkPriceFeedV3Event {
     /// @return timestamp The last cached valid timestamp
     function getLastValidTimestamp() external view returns (uint256 timestamp);
 
-    /// @notice If the interval is zero, returns the latest valid price.
-    ///         Else, returns TWAP calculating with the latest valid price and timestamp.
-    /// @dev This is the view version of cacheTwap()
-    /// @param interval TWAP interval
-    /// @return price The last valid price or TWAP
-    function getPrice(uint256 interval) external view returns (uint256 price);
-
     /// @notice Retrieve the latest price and timestamp from Chainlink aggregator,
     ///         or return the last cached valid price and timestamp if the aggregator hasn't been updated or is frozen.
     /// @return price The latest valid price
@@ -58,7 +51,4 @@ interface IChainlinkPriceFeedV3 is IChainlinkPriceFeedV3Event {
 
     /// @return period The timeout period
     function getTimeout() external view returns (uint256 period);
-
-    /// @return decimals The decimals of price feed
-    function decimals() external view returns (uint8 decimals);
 }

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@perp/perp-oracle-contract",
-  "version": "0.6.5",
+  "version": "0.6.7",
   "description": "Perpetual Protocol Curie (v2) oracle contracts - v0.5.0 is not an audited version",
   "license": "GPL-3.0-or-later",
   "author": {

package.json

@@ -179,6 +179,7 @@ contract PriceFeedDispatcherTest is IPriceFeedDispatcherEvent, PriceFeedDispatch
     function _dispatchPrice_and_assertEq_getDispatchedPrice(uint256 price) internal {
         _priceFeedDispatcher.dispatchPrice(0);
         assertEq(_priceFeedDispatcher.getDispatchedPrice(0), price);
+        assertEq(_priceFeedDispatcher.getPrice(0), price);
     }
 
     function _expect_emit_event_from_PriceFeedDispatcher() internal {