Update market oracle signature (#8)

brandoniles · web-flow · commit 01a96102f9bb · 2018-07-09T12:18:29.000-07:00
* Bumping dep versions, fixing lint warnings

* update oracle name

* removing intellij files

* volume type
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -36,7 +36,7 @@ module.exports = {
               "deployer", "http", "https", "github", "chai", "argv", "evm",
               "jsonrpc", "timestamp", "uint256", "erc20", "bignumber", "lodash",
               "arg", "npm", "seedrandom", "eql", "sinon", "yaml", "promisify",
-              "passcode", "geth", "rpc", "rpcmsg","stdev",  "stochasm", "aggregator",
+              "passcode", "geth", "rpc", "rpcmsg","stdev",  "stochasm",
               "whitelist", "uint",
 
               // shorthand
diff --git a/contracts/UFragmentsPolicy.sol b/contracts/UFragmentsPolicy.sol
@@ -6,23 +6,23 @@ import "openzeppelin-solidity/contracts/ownership/Ownable.sol";
 import "./UFragments.sol";
 
 
-interface ExchangeRateAggregator {
-    function aggregate() external returns (uint128, uint256);
+interface MarketOracle {
+    function getPriceAndVolume() external returns (uint128, uint128);
 }
 
 
 /**
  * @title uFragments Monetary Supply Policy
  * @notice This component regulates the token supply of the uFragments ERC20 token in response to
- *         price-feed oracles.
+ *         market oracles.
  */
 contract UFragmentsPolicy is Ownable {
     using SafeMath for uint256;
 
-    event Rebase(uint256 indexed epoch, uint128 exchangeRate, uint256 volume, int256 appliedSupplyAdjustment);
+    event Rebase(uint256 indexed epoch, uint128 exchangeRate, uint128 volume, int256 appliedSupplyAdjustment);
 
     UFragments private uFrags;
-    ExchangeRateAggregator private rateAggregator;
+    MarketOracle private marketOracle;
 
     // Timestamp of last rebase operation
     uint256 public lastRebaseTimestamp;
@@ -47,9 +47,9 @@ contract UFragmentsPolicy is Ownable {
     // The upper bound on uFragments' supply
     uint256 private constant MAX_SUPPLY = 2**128 - 1;
 
-    constructor(UFragments _uFrags, ExchangeRateAggregator _rateAggregator) public {
+    constructor(UFragments _uFrags, MarketOracle _marketOracle) public {
         uFrags = _uFrags;
-        rateAggregator = _rateAggregator;
+        marketOracle = _marketOracle;
     }
 
     /**
@@ -62,8 +62,8 @@ contract UFragmentsPolicy is Ownable {
         lastRebaseTimestamp = now;
 
         uint128 exchangeRate;
-        uint256 volume;
-        (exchangeRate, volume) = rateAggregator.aggregate();
+        uint128 volume;
+        (exchangeRate, volume) = marketOracle.getPriceAndVolume();
         int256 supplyDelta = calcSupplyDelta(exchangeRate);
         supplyDelta = calcDampenedSupplyDelta(supplyDelta);
 
@@ -76,8 +76,8 @@ contract UFragmentsPolicy is Ownable {
     }
 
     /**
-     * @notice Allows setting the Deviation Threshold. If the exchange rate given by the exchange
-     *         rate aggregator is within this threshold, then no supply modifications are made.
+     * @notice Allows setting the Deviation Threshold. If the exchange rate given by the market
+     *         oracle is within this threshold, then no supply modifications are made.
      * @param _deviationThreshold The new exchange rate threshold.
      * TODO(iles): This should only be modified through distributed governance. #158010389
      */
@@ -111,7 +111,7 @@ contract UFragmentsPolicy is Ownable {
 
     /**
      * @return The total supply adjustment that should be made in response to the exchange
-     *         rate, as read from the aggregator.
+     *         rate, as provided by the market oracle.
      */
     function calcSupplyDelta(uint128 rate) private view returns (int256) {
         if (withinDeviationThreshold(rate)) {
diff --git a/contracts/mocks/ProxyContract.sol b/contracts/mocks/ProxyContract.sol
@@ -8,7 +8,7 @@ contract ProxyContract {
 
   uint256 private epoch;
   uint128 private exchangeRate;
-  uint256 private volume;
+  uint128 private volume;
   uint256 private supply;
 
   event FunctionCalled(string functionName, address caller);
@@ -23,7 +23,7 @@ contract ProxyContract {
     exchangeRate = _exchangeRate;
   }
 
-  function storeVolume(uint256 _volume) public {
+  function storeVolume(uint128 _volume) public {
     volume = _volume;
   }
 
@@ -46,8 +46,8 @@ contract ProxyContract {
     emit FunctionArguments(uintVals, intVals);
   }
 
-  function aggregate() external returns (uint128, uint256) {
-    emit FunctionCalled("ExchangeRateAggregator:aggregate", msg.sender);
+  function getPriceAndVolume() external returns (uint128, uint128) {
+    emit FunctionCalled("MarketOracle:getPriceAndVolume", msg.sender);
     uint256[] memory uintVals = new uint256[](0);
     int256[] memory intVals = new int256[](0);
     emit FunctionArguments(uintVals, intVals);
diff --git a/scripts/gen_dummy_data.js b/scripts/gen_dummy_data.js
@@ -43,7 +43,7 @@ async function mockData () {
     supply = await uFragments.totalSupply.call();
     supply = new BigNumber(supply);
 
-    // Mocking policy interactions with aggregator and uFragments
+    // Mocking policy interactions with oracle and uFragments
     await proxy.storeRate(rate, txConfig);
     await proxy.storeSupply(supply, txConfig);
     await proxy.storeVolume(volume, txConfig);
diff --git a/test/logs/gas-utilization.yaml b/test/logs/gas-utilization.yaml
@@ -1,7 +1,7 @@
 # Code generated - DO NOT EDIT.
 # Any manual changes may be lost.
 'UFragments:DEPLOYMENT': 1816916
-'UFragments:rebase(1, +100) [VIA PROXY]': 31446
+'UFragments:rebase(1, +100) [VIA PROXY]': 31468
 'UFragments:transfer(user, 10)': 53799
 'UFragments:transferFrom(user, 10)': 46151
-'UFragmentsPolicy:rebase() [WITH STUB]': 84417
+'UFragmentsPolicy:rebase() [WITH STUB]': 84439
diff --git a/test/unit/UFragmentsPolicy.js b/test/unit/UFragmentsPolicy.js
@@ -121,9 +121,9 @@ contract('uFragmentsPolicy', async accounts => {
           expect(log.args.appliedSupplyAdjustment.toNumber()).to.eq(20);
           expect(log.args.volume.toNumber()).to.eq(100);
         });
-        it('should call aggregate from the exchange rate aggregator', async () => {
+        it('should call getPriceAndVolume from the market oracle', async () => {
           const fnCalls = new ProxyContractFunctionSpy(uFragSpy).getCalledFunctions();
-          expect(fnCalls[0].fnName).to.eq('ExchangeRateAggregator:aggregate');
+          expect(fnCalls[0].fnName).to.eq('MarketOracle:getPriceAndVolume');
           expect(fnCalls[0].calledBy).to.eq(uFragmentsPolicy.address);
           expect(fnCalls[0].arguments).to.be.empty;
         });
