Feature/restructure market creation incentives

contracts/MarketRegistryNew.sol

@@ -0,0 +1,139 @@
+/* Copyright (C) 2020 PlotX.io
+
+  This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+    along with this program.  If not, see http://www.gnu.org/licenses/ */
+
+pragma solidity 0.5.7;
+import "./MarketRegistry.sol";
+import "./interfaces/IChainLinkOracle.sol";
+import "./external/openzeppelin-solidity/math/Math.sol";
+
+contract MarketRegistryNew is MarketRegistry {
+
+    uint256 internal maxGasPrice;
+    IChainLinkOracle public clGasPriceAggregator;
+
+    mapping(address => uint256) userIncentives;
+    event MarketCreationReward(address indexed createdBy, uint256 plotIncentive, uint256 gasUsed, uint256 gasCost, uint256 gasPriceConsidered, uint256 gasPriceGiven, uint256 maxGasCap);
+    event ClaimedMarketCreationReward(address indexed user, uint256 plotIncentive);
+
+    /**
+    * @dev Set initial market creation incentive params.
+    */
+    function setGasPriceAggAndMaxGas(address _clGasPriceAggregator) external {
+      require(address(clGasPriceAggregator) == address(0));
+      require(msg.sender == marketInitiater);
+      clGasPriceAggregator = IChainLinkOracle(_clGasPriceAggregator);
+      maxGasPrice = 100 * 10**9;
+    }
+
+    /**
+    * @dev Creates the new market
+    * @param _marketType The type of the market.
+    * @param _marketCurrencyIndex the index of market currency.
+    */
+    function createMarket(uint256 _marketType, uint256 _marketCurrencyIndex) public payable{
+      uint256 gasProvided = gasleft();
+      address penultimateMarket = marketCreationData[_marketType][_marketCurrencyIndex].penultimateMarket;
+      if(penultimateMarket != address(0)) {
+        IMarket(penultimateMarket).settleMarket();
+      }
+      if(marketCreationData[_marketType][_marketCurrencyIndex].marketAddress != address(0)) {
+        (,,,,,,,, uint _status) = getMarketDetails(marketCreationData[_marketType][_marketCurrencyIndex].marketAddress);
+        require(_status >= uint(IMarket.PredictionStatus.InSettlement));
+      }
+      (uint8 _roundOfToNearest, bytes32 _currencyName, address _priceFeed) = IMarket(marketCurrencies[_marketCurrencyIndex].marketImplementation).getMarketFeedData();
+      marketUtility.update();
+      uint64 _marketStartTime = calculateStartTimeForMarket(_marketType, _marketCurrencyIndex);
+      uint64 _optionRangePerc = marketTypes[_marketType].optionRangePerc;
+      uint currentPrice = marketUtility.getAssetPriceUSD(_priceFeed);
+      _optionRangePerc = uint64(currentPrice.mul(_optionRangePerc.div(2)).div(10000));
+      uint64 _decimals = marketCurrencies[_marketCurrencyIndex].decimals;
+      uint64 _minValue = uint64((ceil(currentPrice.sub(_optionRangePerc).div(_roundOfToNearest), 10**_decimals)).mul(_roundOfToNearest));
+      uint64 _maxValue = uint64((ceil(currentPrice.add(_optionRangePerc).div(_roundOfToNearest), 10**_decimals)).mul(_roundOfToNearest));
+      _createMarket(_marketType, _marketCurrencyIndex, _minValue, _maxValue, _marketStartTime, _currencyName);
+      uint256 gasUsed = gasProvided - gasleft();
+      _calculateIncentive(gasUsed);
+    }
+
+    /**
+    * @dev internal function to calculate user incentive for market creation
+    */
+    function _calculateIncentive(uint256 gasUsed) internal{
+      //Adding buffer gas for below calculations
+      gasUsed = gasUsed + 38500;
+      uint256 gasPrice = _checkGasPrice();
+      uint256 gasCost = gasUsed.mul(gasPrice);
+      (, uint256 incentive) = marketUtility.getValueAndMultiplierParameters(ETH_ADDRESS, gasCost);
+      userIncentives[msg.sender] = userIncentives[msg.sender].add(incentive);
+      emit MarketCreationReward(msg.sender, incentive, gasUsed, gasCost, gasPrice, tx.gasprice, maxGasPrice);
+    }
+
+    /**
+    * @dev internal function to calculate gas price for market creation incentives
+    */
+    function _checkGasPrice() internal view returns(uint256) {
+      uint fastGas = uint(clGasPriceAggregator.latestAnswer());
+      uint fastGasWithMaxDeviation = fastGas.mul(125).div(100);
+      return Math.min(Math.min(tx.gasprice,fastGasWithMaxDeviation), maxGasPrice);
+    }
+
+
+    /**
+    * @dev function to reward user for initiating market creation calls as per the new incetive calculations
+    */
+    function claimCreationRewardV2() external {
+      uint256 pendingPLOTReward = userIncentives[msg.sender];
+      require(pendingPLOTReward > 0);
+      delete userIncentives[msg.sender];
+      _transferAsset(address(plotToken), msg.sender, pendingPLOTReward);
+      emit ClaimedMarketCreationReward(msg.sender, pendingPLOTReward);
+    }
+
+    /**
+    * @dev function to update address parameters of market
+    */
+    function updateConfigAddressParameters(bytes8 code, address payable value) external onlyAuthorizedToGovern {
+      if(code == "GASAGG") { // Incentive to be distributed to user for market creation
+        clGasPriceAggregator = IChainLinkOracle(value);
+      } else {
+        marketUtility.updateAddressParameters(code, value);
+      }
+    }
+
+    /**
+    * @dev function to update integer parameters of market
+    */
+    function updateUintParameters(bytes8 code, uint256 value) external onlyAuthorizedToGovern {
+      if(code == "MCRINC") { // Incentive to be distributed to user for market creation
+        marketCreationIncentive = value;
+      } else if(code == "MAXGAS") { // Maximum gas upto which is considered while calculating market creation incentives
+        maxGasPrice = value;
+      } else {
+        marketUtility.updateUintParameters(code, value);
+      }
+    }
+
+    /**
+    * @dev Get uint config parameters
+    */
+    function getUintParameters(bytes8 code) external view returns(bytes8 codeVal, uint256 value) {
+      codeVal = code;
+      if(code == "MCRINC") {
+        value = marketCreationIncentive;
+      } else if(code == "MAXGAS") {
+        value = maxGasPrice;
+      }
+    }
+
+}

contracts/interfaces/IMarketUtility.sol

@@ -69,4 +69,15 @@ contract IMarketUtility {
         address _currencyFeedAddress,
         uint256 _settleTime
     ) public view returns (uint256 latestAnswer, uint256 roundId);
+
+    /**
+     * @dev Get value of provided currency address in ETH
+     * @param _currencyAddress Address of currency
+     * @param _amount Amount of provided currency
+     * @return Value of provided amount in ETH
+     **/
+    function getAssetValueETH(address _currencyAddress, uint256 _amount)
+        public
+        view
+        returns (uint256 tokenEthValue);
 }

contracts/mock/MockChainLinkAggregator.sol

@@ -3,49 +3,49 @@ pragma solidity 0.5.7;
 import "../interfaces/IChainLinkOracle.sol";
 contract MockChainLinkAggregator is IChainLinkOracle{
 
-	 int256 latestAns = 934999802346;
-	 uint256 updatedAt = now;
+	int256 latestAns = 934999802346;
+	uint256 updatedAt = now;
 
-   struct RoundData {
-      uint80 roundId;
-      int256 answer;
-      uint256 startedAt;
-      uint256 updatedAt;
-      uint80 answeredInRound;
-   }
+  struct RoundData {
+    uint80 roundId;
+    int256 answer;
+    uint256 startedAt;
+    uint256 updatedAt;
+    uint80 answeredInRound;
+  }
 
-   mapping(uint80 => RoundData) public roundData;
-   uint80 public currentRound;
+  mapping(uint80 => RoundData) public roundData;
+  uint80 public currentRound;
 
-   constructor() public {
-      currentRound = 0;
-      roundData[0] = RoundData(uint80(0),latestAns, updatedAt, updatedAt, uint80(0));
-   }
+  constructor() public {
+    currentRound = 0;
+    roundData[0] = RoundData(uint80(0),latestAns, updatedAt, updatedAt, uint80(0));
+  }
 
   function decimals() external view returns (uint8) {
     return uint8(8);
   }
-	/**
-    * @dev Gets the latest answer of chainLink oracle.
-    * @return int256 representing the latest answer of chainLink oracle.
-    */
-	 function latestAnswer() external view returns (int256)
-	 {
-	 	return roundData[currentRound].answer;
 
-	 }
+	/**
+  * @dev Gets the latest answer of chainLink oracle.
+  * @return int256 representing the latest answer of chainLink oracle.
+  */
+	function latestAnswer() external view returns (int256)
+	{
+		return roundData[currentRound].answer;
+	}
 
 	/**
-    * @dev Set the latest answer of chainLink oracle.
-    * @param _latestAnswer The latest anser of chainLink oracle.
-    */
-	 function setLatestAnswer(int256 _latestAnswer) public
-	 {
+  * @dev Set the latest answer of chainLink oracle.
+  * @param _latestAnswer The latest anser of chainLink oracle.
+  */
+	function setLatestAnswer(int256 _latestAnswer) public
+	{
     currentRound = currentRound + uint80(1);
     roundData[currentRound] = RoundData(currentRound,_latestAnswer, now, now, currentRound);
-	 }
+	}
 
-	 function getRoundData(uint80 _roundId)
+	function getRoundData(uint80 _roundId)
     external
     view
     returns (
@@ -54,12 +54,13 @@ contract MockChainLinkAggregator is IChainLinkOracle{
       uint256 startedAt,
       uint256 updatedAt,
       uint80 answeredInRound
-    ) {
-    	return (roundData[_roundId].roundId, roundData[_roundId].answer, roundData[_roundId].startedAt,
-              roundData[_roundId].updatedAt,roundData[_roundId].answeredInRound);
-    }
+    )
+  {
+  	return (roundData[_roundId].roundId, roundData[_roundId].answer, roundData[_roundId].startedAt,
+            roundData[_roundId].updatedAt,roundData[_roundId].answeredInRound);
+  }
 
-  	function latestRoundData()
+  function latestRoundData()
     external
     view
     returns (
@@ -68,9 +69,10 @@ contract MockChainLinkAggregator is IChainLinkOracle{
       uint256 startedAt,
       uint256 updatedAt,
       uint80 answeredInRound
-    ) {
-    	return (roundData[currentRound].roundId, roundData[currentRound].answer, roundData[currentRound].startedAt,
-              roundData[currentRound].updatedAt,roundData[currentRound].answeredInRound);
-    }
+    )
+  {
+  	return (roundData[currentRound].roundId, roundData[currentRound].answer, roundData[currentRound].startedAt,
+            roundData[currentRound].updatedAt,roundData[currentRound].answeredInRound);
+  }
 
 }

contracts/mock/MockChainLinkGasPriceAgg.sol

@@ -0,0 +1,76 @@
+pragma solidity 0.5.7;
+
+import "../interfaces/IChainLinkOracle.sol";
+contract MockChainLinkGasPriceAgg is IChainLinkOracle{
+
+	 int256 latestAns = 45000000000;
+	 uint256 updatedAt = now;
+
+   struct RoundData {
+      uint80 roundId;
+      int256 answer;
+      uint256 startedAt;
+      uint256 updatedAt;
+      uint80 answeredInRound;
+   }
+
+   mapping(uint80 => RoundData) public roundData;
+   uint80 public currentRound;
+
+   constructor() public {
+      currentRound = 0;
+      roundData[0] = RoundData(uint80(0),latestAns, updatedAt, updatedAt, uint80(0));
+   }
+
+  function decimals() external view returns (uint8) {
+    return uint8(8);
+  }
+	/**
+    * @dev Gets the latest answer of chainLink oracle.
+    * @return int256 representing the latest answer of chainLink oracle.
+    */
+	 function latestAnswer() external view returns (int256)
+	 {
+	 	return roundData[currentRound].answer;
+
+	 }
+
+	/**
+    * @dev Set the latest answer of chainLink oracle.
+    * @param _latestAnswer The latest anser of chainLink oracle.
+    */
+	 function setLatestAnswer(int256 _latestAnswer) public
+	 {
+    currentRound = currentRound + uint80(1);
+    roundData[currentRound] = RoundData(currentRound,_latestAnswer, now, now, currentRound);
+	 }
+
+	 function getRoundData(uint80 _roundId)
+    external
+    view
+    returns (
+      uint80 roundId,
+      int256 answer,
+      uint256 startedAt,
+      uint256 updatedAt,
+      uint80 answeredInRound
+    ) {
+    	return (roundData[_roundId].roundId, roundData[_roundId].answer, roundData[_roundId].startedAt,
+              roundData[_roundId].updatedAt,roundData[_roundId].answeredInRound);
+    }
+
+  	function latestRoundData()
+    external
+    view
+    returns (
+      uint80 roundId,
+      int256 answer,
+      uint256 startedAt,
+      uint256 updatedAt,
+      uint80 answeredInRound
+    ) {
+    	return (roundData[currentRound].roundId, roundData[currentRound].answer, roundData[currentRound].startedAt,
+              roundData[currentRound].updatedAt,roundData[currentRound].answeredInRound);
+    }
+
+}

migrations/2_deploy.js

@@ -66,6 +66,10 @@ module.exports = function(deployer, network, accounts){
       // console.log(await plotus.getOpenMarkets());
       await plotusToken.transfer(uniswapRouter.address, "100000000000000000000");
       await plotusToken.transfer(plotus.address, "10000000000000000000000");
+      // await blotToken.addMinter(plotusAddress);
+      // await plotusToken.approve(blotToken.address, "1000000000000000000000000000");
+      // await blotToken.mint(plotus.address, "10000000000000000000000");
+      // await plotus.setInitialCreationIncentives();
   });
 };