Merge pull request #616 from PolymathNetwork/price-in-poly

Define price in poly or usd
PolymathNetwork · Apr 1, 2019 · 9bd9d47 · 9bd9d47
2 parents 9a80c01 + 2f11b69
commit 9bd9d47
Show file tree

Hide file tree

Showing 37 changed files with 370 additions and 153 deletions.
diff --git a/contracts/STRGetter.sol b/contracts/STRGetter.sol
@@ -14,6 +14,7 @@ contract STRGetter is EternalStorage {
     bytes32 constant STLAUNCHFEE = 0xd677304bb45536bb7fdfa6b9e47a3c58fe413f9e8f01474b0a4b9c6e0275baf2;
     bytes32 constant TICKERREGFEE = 0x2fcc69711628630fb5a42566c68bd1092bc4aa26826736293969fddcd11cb2d2;
     bytes32 constant EXPIRYLIMIT = 0x604268e9a73dfd777dcecb8a614493dd65c638bad2f5e7d709d378bd2fb0baee;
+    bytes32 constant IS_FEE_IN_POLY = 0x7152e5426955da44af11ecd67fec5e2a3ba747be974678842afa9394b9a075b6; //keccak256("IS_FEE_IN_POLY")
 
     /**
      * @notice Returns the list of tickers owned by the selected address
@@ -242,6 +243,14 @@ contract STRGetter is EternalStorage {
         return getUintValue(TICKERREGFEE);
     }
 
+    /**
+     * @notice Gets the fee currency
+     * @return true = poly, false = usd
+     */
+    function getIsFeeInPoly() public view returns(bool) {
+        return getBoolValue(IS_FEE_IN_POLY);
+    }
+
     /**
      * @notice Gets the expiry limit
      * @return Expiry limit

diff --git a/contracts/SecurityTokenRegistry.sol b/contracts/SecurityTokenRegistry.sol
@@ -75,6 +75,7 @@ contract SecurityTokenRegistry is EternalStorage, Proxy {
     bytes32 constant OWNER = 0x02016836a56b71f0d02689e69e326f4f4c1b9057164ef592671cf0d37c8040c0;
     bytes32 constant POLYMATHREGISTRY = 0x90eeab7c36075577c7cc5ff366e389fefa8a18289b949bab3529ab4471139d4d;
     bytes32 constant STRGETTER = 0x982f24b3bd80807ec3cb227ba152e15c07d66855fa8ae6ca536e689205c0e2e9;
+    bytes32 constant IS_FEE_IN_POLY = 0x7152e5426955da44af11ecd67fec5e2a3ba747be974678842afa9394b9a075b6; //keccak256("IS_FEE_IN_POLY")
 
     string constant POLY_ORACLE = "StablePolyUsdOracle";
 
@@ -90,6 +91,8 @@ contract SecurityTokenRegistry is EternalStorage, Proxy {
     event ChangeSecurityLaunchFee(uint256 _oldFee, uint256 _newFee);
     // Emit when changeTickerRegistrationFee is called
     event ChangeTickerRegistrationFee(uint256 _oldFee, uint256 _newFee);
+    // Emit when Fee currency is changed
+    event ChangeFeeCurrency(bool _isFeeInPoly);
     // Emit when ownership gets transferred
     event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
     // Emit when ownership of the ticker gets changed
@@ -226,12 +229,18 @@ contract SecurityTokenRegistry is EternalStorage, Proxy {
      * @notice Returns the usd & poly fee for a particular feetype
      * @param _feeType Key corresponding to fee type
      */
-    function getFees(bytes32 _feeType) public returns (uint256, uint256) {
+    function getFees(bytes32 _feeType) public returns (uint256 usdFee, uint256 polyFee) {
+        bool isFeesInPoly = getBoolValue(IS_FEE_IN_POLY);
+        uint256 rawFee = getUintValue(_feeType);
         address polymathRegistry = getAddressValue(POLYMATHREGISTRY);
         uint256 polyRate = IOracle(IPolymathRegistry(polymathRegistry).getAddress(POLY_ORACLE)).getPrice();
-        uint256 usdFee = getUintValue(_feeType);
-        uint256 polyFee = DecimalMath.div(usdFee, polyRate);
-        return (usdFee, polyFee);
+        if (!isFeesInPoly) { //Fee is in USD and not poly
+            usdFee = rawFee;
+            polyFee = DecimalMath.div(rawFee, polyRate);
+        } else {
+            usdFee = DecimalMath.mul(rawFee, polyRate);
+            polyFee = rawFee;
+        }
     }
 
     /**
@@ -518,7 +527,7 @@ contract SecurityTokenRegistry is EternalStorage, Proxy {
         require(_tickerOwner(ticker) == msg.sender, "Not authorised");
         /*solium-disable-next-line security/no-block-members*/
         require(getUintValue(Encoder.getKey("registeredTickers_expiryDate", ticker)) >= now, "Ticker expired");
-        _deployToken(_name, ticker, _tokenDetails, msg.sender, _divisible, _treasuryWallet, protocolVersion); 
+        _deployToken(_name, ticker, _tokenDetails, msg.sender, _divisible, _treasuryWallet, protocolVersion);
     }
 
     function _deployToken(
@@ -529,7 +538,7 @@ contract SecurityTokenRegistry is EternalStorage, Proxy {
         bool _divisible,
         address _wallet,
         uint256 _protocolVersion
-    ) 
+    )
         internal
     {
         (uint256 _usdFee, uint256 _polyFee) = _takeFee(STLAUNCHFEE);
@@ -572,7 +581,7 @@ contract SecurityTokenRegistry is EternalStorage, Proxy {
     )
         external
         onlyOwner
-    {   
+    {
         require(bytes(_name).length > 0 && bytes(_ticker).length > 0, "Bad data");
         require(bytes(_ticker).length <= 10, "Bad ticker");
         require(_deployedAt != 0 && _owner != address(0), "Bad data");
@@ -655,8 +664,12 @@ contract SecurityTokenRegistry is EternalStorage, Proxy {
     function changeTickerRegistrationFee(uint256 _tickerRegFee) external onlyOwner {
         uint256 fee = getUintValue(TICKERREGFEE);
         require(fee != _tickerRegFee, "Bad fee");
-        emit ChangeTickerRegistrationFee(fee, _tickerRegFee);
-        set(TICKERREGFEE, _tickerRegFee);
+        _changeTickerRegistrationFee(fee, _tickerRegFee);
+    }
+
+    function _changeTickerRegistrationFee(uint256 _oldFee, uint256 _newFee) internal {
+        emit ChangeTickerRegistrationFee(_oldFee, _newFee);
+        set(TICKERREGFEE, _newFee);
     }
 
     /**
@@ -666,8 +679,29 @@ contract SecurityTokenRegistry is EternalStorage, Proxy {
     function changeSecurityLaunchFee(uint256 _stLaunchFee) external onlyOwner {
         uint256 fee = getUintValue(STLAUNCHFEE);
         require(fee != _stLaunchFee, "Bad fee");
-        emit ChangeSecurityLaunchFee(fee, _stLaunchFee);
-        set(STLAUNCHFEE, _stLaunchFee);
+        _changeSecurityLaunchFee(fee, _stLaunchFee);
+    }
+
+    function _changeSecurityLaunchFee(uint256 _oldFee, uint256 _newFee) internal {
+        emit ChangeSecurityLaunchFee(_oldFee, _newFee);
+        set(STLAUNCHFEE, _newFee);
+    }
+
+    /**
+    * @notice Sets the ticker registration and ST launch fee amount and currency
+    * @param _tickerRegFee is the ticker registration fee (base 18 decimals)
+    * @param _stLaunchFee is the st generation fee (base 18 decimals)
+    * @param _isFeeInPoly defines if the fee is in poly or usd
+    */
+    function changeFeesAmountAndCurrency(uint256 _tickerRegFee, uint256 _stLaunchFee, bool _isFeeInPoly) external onlyOwner {
+        uint256 tickerFee = getUintValue(TICKERREGFEE);
+        uint256 stFee = getUintValue(STLAUNCHFEE);
+        bool isOldFeesInPoly = getBoolValue(IS_FEE_IN_POLY);
+        require(isOldFeesInPoly != _isFeeInPoly, "Currency unchanged");
+        _changeTickerRegistrationFee(tickerFee, _tickerRegFee);
+        _changeSecurityLaunchFee(stFee, _stLaunchFee);
+        emit ChangeFeeCurrency(_isFeeInPoly);
+        set(IS_FEE_IN_POLY, _isFeeInPoly);
     }
 
     /**

diff --git a/contracts/interfaces/IModuleFactory.sol b/contracts/interfaces/IModuleFactory.sol
@@ -5,6 +5,7 @@ pragma solidity ^0.5.0;
  */
 interface IModuleFactory {
     event ChangeSetupCost(uint256 _oldSetupCost, uint256 _newSetupCost);
+    event ChangeCostType(bool _isOldCostInPoly, bool _isNewCostInPoly);
     event ChangeUsageCost(uint256 _oldUsageCost, uint256 _newUsageCost);
     event GenerateModuleFromFactory(
         address _module,
@@ -71,6 +72,14 @@ interface IModuleFactory {
      */
     function changeUsageCost(uint256 _newUsageCost) external;
 
+    /**
+     * @notice Used to change the currency and amount of usage and setup cost
+     * @param _setupCost new setup cost
+     * @param _usageCost new usage cost
+     * @param _isCostInPoly new usage cost currency. USD or POLY
+     */
+    function changeCostsAndType(uint256 _setupCost, uint256 _usageCost, bool _isCostInPoly) external;
+
     /**
      * @notice Function use to change the lower and upper bound of the compatible version st
      * @param _boundType Type of bound

diff --git a/contracts/interfaces/ISecurityTokenRegistry.sol b/contracts/interfaces/ISecurityTokenRegistry.sol
@@ -175,18 +175,26 @@ interface ISecurityTokenRegistry {
      */
     function changeExpiryLimit(uint256 _newExpiry) external;
 
-    /**
-    * @notice Sets the ticker registration fee in POLY tokens
-    * @param _tickerRegFee Registration fee in POLY tokens (base 18 decimals)
+   /**
+    * @notice Sets the ticker registration fee in USD tokens. Only Polymath.
+    * @param _tickerRegFee is the registration fee in USD tokens (base 18 decimals)
     */
     function changeTickerRegistrationFee(uint256 _tickerRegFee) external;
 
     /**
-    * @notice Sets the ticker registration fee in POLY tokens
-    * @param _stLaunchFee Registration fee in POLY tokens (base 18 decimals)
+    * @notice Sets the ticker registration fee in USD tokens. Only Polymath.
+    * @param _stLaunchFee is the registration fee in USD tokens (base 18 decimals)
     */
     function changeSecurityLaunchFee(uint256 _stLaunchFee) external;
 
+    /**
+    * @notice Sets the ticker registration and ST launch fee amount and currency
+    * @param _tickerRegFee is the ticker registration fee (base 18 decimals)
+    * @param _stLaunchFee is the st generation fee (base 18 decimals)
+    * @param _isFeeInPoly defines if the fee is in poly or usd
+    */
+    function changeFeesAmountAndCurrency(uint256 _tickerRegFee, uint256 _stLaunchFee, bool _isFeeInPoly) external;
+
     /**
      * @notice Gets the security token launch fee
      * @return Fee amount

diff --git a/contracts/mocks/Dummy/DummySTOFactory.sol b/contracts/mocks/Dummy/DummySTOFactory.sol
@@ -16,15 +16,17 @@ contract DummySTOFactory is UpgradableModuleFactory {
      * @param _usageCost Usage cost of the module
      * @param _logicContract Contract address that contains the logic related to `description`
      * @param _polymathRegistry Address of the Polymath registry
+     * @param _isCostInPoly true = cost in Poly, false = USD
      */
-    constructor(
+    constructor (
         uint256 _setupCost,
         uint256 _usageCost,
         address _logicContract,
-        address _polymathRegistry
+        address _polymathRegistry,
+        bool _isCostInPoly
     )
         public
-        UpgradableModuleFactory("3.0.0", _setupCost, _usageCost, _logicContract, _polymathRegistry)
+        UpgradableModuleFactory("3.0.0", _setupCost, _usageCost, _logicContract, _polymathRegistry, _isCostInPoly)
     {
         name = "DummySTO";
         title = "Dummy STO";

diff --git a/contracts/mocks/MockBurnFactory.sol b/contracts/mocks/MockBurnFactory.sol
@@ -18,10 +18,11 @@ contract MockBurnFactory is TrackedRedemptionFactory {
     constructor(
         uint256 _setupCost,
         uint256 _usageCost,
-        address _polymathRegistry
+        address _polymathRegistry,
+        bool _isFeeInPoly
     )
         public
-        TrackedRedemptionFactory(_setupCost, _usageCost, _polymathRegistry)
+        TrackedRedemptionFactory(_setupCost, _usageCost, _polymathRegistry, _isFeeInPoly)
     {
 
     }

diff --git a/contracts/mocks/MockFactory.sol b/contracts/mocks/MockFactory.sol
@@ -20,10 +20,11 @@ contract MockFactory is DummySTOFactory {
         uint256 _setupCost,
         uint256 _usageCost,
         address _logicContract,
-        address _polymathRegistry
+        address _polymathRegistry,
+        bool _isFeeInPoly
     )
         public
-        DummySTOFactory(_setupCost, _usageCost, _logicContract, _polymathRegistry)
+        DummySTOFactory(_setupCost, _usageCost, _logicContract, _polymathRegistry, _isFeeInPoly)
     {
     }
 

diff --git a/contracts/mocks/MockWrongTypeFactory.sol b/contracts/mocks/MockWrongTypeFactory.sol
@@ -18,10 +18,11 @@ contract MockWrongTypeFactory is MockBurnFactory {
     constructor(
         uint256 _setupCost,
         uint256 _usageCost,
-        address _polymathRegistry
+        address _polymathRegistry,
+        bool _isFeeInPoly
     )
         public
-        MockBurnFactory(_setupCost, _usageCost, _polymathRegistry)
+        MockBurnFactory(_setupCost, _usageCost, _polymathRegistry, _isFeeInPoly)
     {
 
     }

diff --git a/contracts/mocks/TestSTOFactory.sol b/contracts/mocks/TestSTOFactory.sol
@@ -14,10 +14,11 @@ contract TestSTOFactory is DummySTOFactory {
         uint256 _setupCost,
         uint256 _usageCost,
         address _logicContract,
-        address _polymathRegistry
+        address _polymathRegistry,
+        bool _isFeeInPoly
     )
         public
-        DummySTOFactory(_setupCost, _usageCost, _logicContract, _polymathRegistry)
+        DummySTOFactory(_setupCost, _usageCost, _logicContract, _polymathRegistry, _isFeeInPoly)
     {
         name = "TestSTO";
         title = "Test STO";

diff --git a/contracts/modules/Checkpoint/ERC20/ERC20DividendCheckpointFactory.sol b/contracts/modules/Checkpoint/ERC20/ERC20DividendCheckpointFactory.sol
@@ -16,15 +16,17 @@ contract ERC20DividendCheckpointFactory is UpgradableModuleFactory {
      * @param _usageCost Usage cost of the module
      * @param _logicContract Contract address that contains the logic related to `description`
      * @param _polymathRegistry Address of the Polymath registry
+     * @param _isCostInPoly true = cost in Poly, false = USD
      */
-    constructor(
+    constructor (
         uint256 _setupCost,
         uint256 _usageCost,
         address _logicContract,
-        address _polymathRegistry
+        address _polymathRegistry,
+        bool _isCostInPoly
     )
         public
-        UpgradableModuleFactory("3.0.0", _setupCost, _usageCost, _logicContract, _polymathRegistry)
+        UpgradableModuleFactory("3.0.0", _setupCost, _usageCost, _logicContract, _polymathRegistry, _isCostInPoly)
     {
         name = "ERC20DividendCheckpoint";
         title = "ERC20 Dividend Checkpoint";

diff --git a/contracts/modules/Checkpoint/Ether/EtherDividendCheckpointFactory.sol b/contracts/modules/Checkpoint/Ether/EtherDividendCheckpointFactory.sol
@@ -16,15 +16,17 @@ contract EtherDividendCheckpointFactory is UpgradableModuleFactory {
      * @param _usageCost Usage cost of the module
      * @param _logicContract Contract address that contains the logic related to `description`
      * @param _polymathRegistry Address of the Polymath registry
+     * @param _isCostInPoly true = cost in Poly, false = USD
      */
-    constructor(
+    constructor (
         uint256 _setupCost,
         uint256 _usageCost,
         address _logicContract,
-        address _polymathRegistry
+        address _polymathRegistry,
+        bool _isCostInPoly
     )
         public
-        UpgradableModuleFactory("3.0.0", _setupCost, _usageCost, _logicContract, _polymathRegistry)
+        UpgradableModuleFactory("3.0.0", _setupCost, _usageCost, _logicContract, _polymathRegistry, _isCostInPoly)
     {
         name = "EtherDividendCheckpoint";
         title = "Ether Dividend Checkpoint";

diff --git a/contracts/modules/Experimental/Burn/TrackedRedemptionFactory.sol b/contracts/modules/Experimental/Burn/TrackedRedemptionFactory.sol
@@ -12,14 +12,15 @@ contract TrackedRedemptionFactory is ModuleFactory {
      * @param _setupCost Setup cost of module
      * @param _usageCost Usage cost of module
      * @param _polymathRegistry Address of the Polymath registry
+     * @param _isCostInPoly true = cost in Poly, false = USD
      */
     constructor(
         uint256 _setupCost,
         uint256 _usageCost,
-        address _polymathRegistry
+        address _polymathRegistry,
+        bool _isCostInPoly
     )
-        public
-        ModuleFactory(_setupCost, _usageCost, _polymathRegistry)
+        public ModuleFactory(_setupCost, _usageCost, _polymathRegistry, _isCostInPoly)
     {
         initialVersion = "3.0.0";
         name = "TrackedRedemption";

diff --git a/contracts/modules/Experimental/Mixed/ScheduledCheckpointFactory.sol b/contracts/modules/Experimental/Mixed/ScheduledCheckpointFactory.sol
@@ -12,14 +12,15 @@ contract ScheduledCheckpointFactory is ModuleFactory {
      * @param _setupCost Setup cost of the module
      * @param _usageCost Usage cost of the module
      * @param _polymathRegistry Address of the Polymath registry
+     * @param _isCostInPoly true = cost in Poly, false = USD
      */
     constructor(
         uint256 _setupCost,
         uint256 _usageCost,
-        address _polymathRegistry
+        address _polymathRegistry,
+        bool _isCostInPoly
     )
-        public
-        ModuleFactory(_setupCost, _usageCost, _polymathRegistry)
+        public ModuleFactory(_setupCost, _usageCost, _polymathRegistry, _isCostInPoly)
     {
         initialVersion = "3.0.0";
         name = "ScheduledCheckpoint";

diff --git a/contracts/modules/Experimental/TransferManager/BlacklistTransferManagerFactory.sol b/contracts/modules/Experimental/TransferManager/BlacklistTransferManagerFactory.sol
@@ -14,9 +14,15 @@ contract BlacklistTransferManagerFactory is ModuleFactory {
      * @param _setupCost Setup cost of the module
      * @param _usageCost Usage cost of the module
      * @param _polymathRegistry Address of the Polymath registry
+     * @param _isCostInPoly true = cost in Poly, false = USD
      */
-    constructor (uint256 _setupCost, uint256 _usageCost, address _polymathRegistry) public
-    ModuleFactory(_setupCost, _usageCost, _polymathRegistry)
+    constructor(
+        uint256 _setupCost,
+        uint256 _usageCost,
+        address _polymathRegistry,
+        bool _isCostInPoly
+    )
+        public ModuleFactory(_setupCost, _usageCost, _polymathRegistry, _isCostInPoly)
     {
         initialVersion = "3.0.0";
         name = "BlacklistTransferManager";

diff --git a/contracts/modules/Experimental/TransferManager/KYCTransferManagerFactory.sol b/contracts/modules/Experimental/TransferManager/KYCTransferManagerFactory.sol
@@ -9,8 +9,13 @@ contract KYCTransferManagerFactory is ModuleFactory {
     /**
      * @notice Constructor
      */
-    constructor (uint256 _setupCost, uint256 _usageCost, address _polymathRegistry) public
-    ModuleFactory(_setupCost, _usageCost, _polymathRegistry)
+    constructor(
+        uint256 _setupCost,
+        uint256 _usageCost,
+        address _polymathRegistry,
+        bool _isCostInPoly
+    )
+        public ModuleFactory(_setupCost, _usageCost, _polymathRegistry, _isCostInPoly)
     {
         initialVersion = "3.0.0";
         name = "KYCTransferManager";