Colony-specific decay rates

Author: area

contracts/colony/Colony.sol

@@ -332,6 +332,9 @@ contract Colony is BasicMetaTransaction, Multicall, ColonyStorage, PatriciaTreeP
     tokenReputationRates[token] = WAD;
     tokensWithReputationRatesLinkedList[address(0x00)] = token;
     nTokensWithReputationRates = 1;
+
+    sig = bytes4(keccak256("setReputationDecayRate(uint256,uint256)"));
+    colonyAuthority.setRoleCapability(uint8(ColonyRole.Root), address(this), sig, true);
   }
 
   function setTokenReputationRate(address _prevToken, address _token, uint256 _rate) public stoppable {
@@ -379,10 +382,6 @@ contract Colony is BasicMetaTransaction, Multicall, ColonyStorage, PatriciaTreeP
     return tokensWithReputationRatesLinkedList[_token];
   }
 
-  function setReputationDecayRate(uint256 _numerator, uint256 _denominator) stoppable auth public {
-    IColonyNetwork(colonyNetworkAddress).setColonyReputationDecayRate(_numerator, _denominator);
-  }
-
   function getMetatransactionNonce(address _user) override public view returns (uint256 nonce){
     return metatransactionNonces[_user];
   }

contracts/colony/ColonyAuthority.sol

@@ -132,6 +132,7 @@ contract ColonyAuthority is CommonAuthority {
 
     // Added in colony v xxxxx
     addRoleCapability(ROOT_ROLE, "setDomainReputationScaling(uint256,bool,uint256)");
+    addRoleCapability(ROOT_ROLE, "setReputationDecayRate(uint256,uint256)");
 
   }
 

contracts/colony/IColony.sol

@@ -1117,7 +1117,6 @@ interface IColony is ColonyDataTypes, IRecovery, IBasicMetaTransaction, IMultica
   /// @param factor The scale factor to apply, as a WAD
   function setDomainReputationScaling(uint256 domainId, bool enabled, uint256 factor) external;
 
-
   /// @notice Call to set the reputation scaling applied to payouts made in a particular token
   /// @param _prevToken The token before where the token being added (_rate > 0) or removed (_rate ==0) in
   /// the list of tokens that have reputation scaling applied
@@ -1140,9 +1139,4 @@ interface IColony is ColonyDataTypes, IRecovery, IBasicMetaTransaction, IMultica
   /// @return address The address of the next token. If 0x00, queried token is either not in the
   /// list or is the last entry in the list.
   function getNextTokenWithReputationRate(address _token) external view returns (address);
-
-  /// @notice Call to set the rate at which reputation in this colony decays
-  /// @param _numerator The numerator of the fraction reputation does down by every reputation cycle
-  /// @param _denominator The denominator of the fraction reputation does down by every reputation cycle
-  function setReputationDecayRate(uint256 _numerator, uint256 _denominator) external;
 }

contracts/colonyNetwork/ColonyNetwork.sol

@@ -332,6 +332,48 @@ contract ColonyNetwork is ColonyDataTypes, BasicMetaTransaction, ColonyNetworkSt
     return factor;
   }
 
+  function setColonyReputationDecayRate(uint256 _numerator, uint256 _denominator) public calledByColony stoppable {
+    require(_numerator < 10**15, "colony-network-decay-numerator-too-big");
+    require(_numerator <= _denominator, "colony-network-decay-rate-over-1");
+
+    ColonyDecayRate storage decayRate = colonyDecayRates[msgSender()];
+
+    if (activeReputationMiningCycle != decayRate.afterMiningCycle) {
+      // Move the old-next values to current, as they are in effect
+      decayRate.currentNumerator = decayRate.nextNumerator;
+      decayRate.currentDenominator = decayRate.nextDenominator;
+
+      // Update afterMiningCycle
+      decayRate.afterMiningCycle = activeReputationMiningCycle;
+    }
+
+    // Whether we've updated the current decays rates or not, we update the next values
+    decayRate.nextNumerator = _numerator;
+    decayRate.nextDenominator = _denominator;
+
+    emit ColonyReputationDecayRateToChange(msgSender(), activeReputationMiningCycle, _numerator, _denominator);
+  }
+
+  function getColonyReputationDecayRate(address _colony) public view returns (uint256, uint256) {
+    uint256 numerator;
+    uint256 denominator;
+
+    if (activeReputationMiningCycle != colonyDecayRates[_colony].afterMiningCycle) {
+      // Then the values of interest is whatever's in nextNumerator/nextDenominator
+      numerator = colonyDecayRates[_colony].nextNumerator;
+      denominator = colonyDecayRates[_colony].nextDenominator;
+    } else {
+      numerator = colonyDecayRates[_colony].currentNumerator;
+      denominator = colonyDecayRates[_colony].currentDenominator;
+    }
+
+    if (denominator == 0) {
+      // Then we return the 'default' decay rate
+      (numerator, denominator) = IReputationMiningCycle(activeReputationMiningCycle).getDecayConstant();
+    }
+    return (numerator, denominator);
+  }
+
   function incrementMetatransactionNonce(address _user) override internal {
     // We need to protect the metatransaction nonce slots, otherwise those with recovery
     // permissions could replay metatransactions, which would be a disaster.

contracts/colonyNetwork/ColonyNetworkDataTypes.sol

@@ -145,6 +145,14 @@ interface ColonyNetworkDataTypes {
   /// @param tokenAuthorityAddress The address of the token authority deployed
   event TokenAuthorityDeployed(address tokenAuthorityAddress);
 
+  /// @notice Event logged when a colony sets what its next decay rate is going to be
+  /// @param colony The colony changing its decay rate
+  /// @param fromCycleCompleted When this mining cycle is completed, the new rate will be in effect
+  /// @param numerator The new numerator of the decay rate
+  /// @param denominator The new denominator of the decay rate
+  event ColonyReputationDecayRateToChange(address colony, address fromCycleCompleted, uint256 numerator, uint256 denominator);
+
+
   struct Skill {
     // total number of parent skills
     uint128 nParents;
@@ -183,4 +191,12 @@ interface ColonyNetworkDataTypes {
     uint256 amount;
     uint256 timestamp;
   }
+
+  struct ColonyDecayRate {
+    uint256 currentNumerator;
+    uint256 currentDenominator;
+    uint256 nextNumerator;
+    uint256 nextDenominator;
+    address afterMiningCycle;
+  }
 }

contracts/colonyNetwork/ColonyNetworkStorage.sol

@@ -106,6 +106,8 @@ contract ColonyNetworkStorage is ColonyNetworkDataTypes, DSMath, CommonStorage {
   // Mining delegation mapping
   mapping(address => address) miningDelegators; // Storage slot 42
 
+  mapping(address => ColonyDecayRate) colonyDecayRates; // Storage slot 43
+
   modifier calledByColony() {
     require(_isColony[msgSender()], "colony-caller-must-be-colony");
     assert(msgSender() == msg.sender);

contracts/colonyNetwork/IColonyNetwork.sol

@@ -476,4 +476,16 @@ interface IColonyNetwork is ColonyNetworkDataTypes, IRecovery, IBasicMetaTransac
   /// If disabling, bool must be false
   /// @param _factor The scale factor to apply, as a WAD
   function setDomainReputationScaling(uint256 _domainId, bool _enabled, uint256 _factor) external;
+
+
+  /// @notice Called by a colony to set the rate at which reputation in that colony decays
+  /// @param _numerator The numerator of the fraction reputation does down by every reputation cycle
+  /// @param _denominator The denominator of the fraction reputation does down by every reputation cycle
+  function setColonyReputationDecayRate(uint256 _numerator, uint256 _denominator) external;
+
+  /// @notice Called to get the rate at which reputation in a colony decays
+  /// @param _colony The address of the colony in question
+  /// @return numerator The numerator of the fraction reputation does down by every reputation cycle
+  /// @return denominator The denominator of the fraction reputation does down by every reputation cycle
+  function getColonyReputationDecayRate(address _colony) external view returns (uint256 numerator, uint256 denominator);
 }

contracts/reputationMiningCycle/ReputationMiningCycleRespond.sol

@@ -531,7 +531,11 @@ contract ReputationMiningCycleRespond is ReputationMiningCycleCommon {
     // We don't care about underflows for the purposes of comparison, but for the calculation we deem 'correct'.
     // i.e. a reputation can't be negative.
     if (u[U_DECAY_TRANSITION] == 1) {
-      require(uint256(_disagreeStateReputationValue) == (uint256(_agreeStateReputationValue)*DECAY_NUMERATOR)/DECAY_DENOMINATOR, "colony-reputation-mining-decay-incorrect");
+      uint256 numerator;
+      uint256 denominator;
+
+      (numerator, denominator) = IColonyNetwork(colonyNetworkAddress).getColonyReputationDecayRate(logEntry.colony);
+      require(uint256(_disagreeStateReputationValue) == (uint256(_agreeStateReputationValue)*numerator)/denominator, "colony-reputation-mining-decay-incorrect");
     } else {
       if (logEntry.amount >= 0) {
         // Don't allow reputation to overflow

docs/interfaces/icolony.md

@@ -1775,6 +1775,19 @@ Sets the skill on an existing payment. Secured function to authorised members.
 |_skillId|uint256|Id of the new skill to set
 
 
+### ▸ `setReputationDecayRate(uint256 _numerator, uint256 _denominator)`
+
+Call to set the rate at which reputation in this colony decays
+
+
+**Parameters**
+
+|Name|Type|Description|
+|---|---|---|
+|_numerator|uint256|The numerator of the fraction reputation does down by every reputation cycle
+|_denominator|uint256|The denominator of the fraction reputation does down by every reputation cycle
+
+
 ### ▸ `setRewardInverse(uint256 _rewardInverse)`
 
 Set the reward inverse to pay out from revenue. e.g. if the fee is 1% (or 0.01), set 100.

docs/interfaces/icolonynetwork.md

@@ -379,6 +379,24 @@ Get the number of colonies in the network.
 |---|---|---|
 |_count|uint256|The colony count
 
+### ▸ `getColonyReputationDecayRate(address _colony):uint256 numerator, uint256 denominator`
+
+Called to get the rate at which reputation in a colony decays
+
+
+**Parameters**
+
+|Name|Type|Description|
+|---|---|---|
+|_colony|address|The address of the colony in question
+
+**Return Parameters**
+
+|Name|Type|Description|
+|---|---|---|
+|numerator|uint256|The numerator of the fraction reputation does down by every reputation cycle
+|denominator|uint256|The denominator of the fraction reputation does down by every reputation cycle
+
 ### ▸ `getColonyVersionResolver(uint256 _version):address _resolverAddress`
 
 Get the `Resolver` address for Colony contract version `_version`.
@@ -885,6 +903,19 @@ Used to track that a user is eligible to claim a reward
 |_amount|uint256|The amount of CLNY to be awarded
 
 
+### ▸ `setColonyReputationDecayRate(uint256 _numerator, uint256 _denominator)`
+
+Called by a colony to set the rate at which reputation in that colony decays
+
+
+**Parameters**
+
+|Name|Type|Description|
+|---|---|---|
+|_numerator|uint256|The numerator of the fraction reputation does down by every reputation cycle
+|_denominator|uint256|The denominator of the fraction reputation does down by every reputation cycle
+
+
 ### ▸ `setDomainReputationScaling(uint256 _domainId, bool _enabled, uint256 _factor)`
 
 Call to set the reputation scaling applied to reputation earned in a domain.