governance: emit parameter updated (#196)

* governance: emit event on each protocol parameter update
* governance: update parameter name
* staking: add rebate and curation fees to settle event

Author: abarmat

contracts/Curation.sol

@@ -124,6 +124,7 @@ contract Curation is Governed, BancorFormula {
         );
 
         defaultReserveRatio = _defaultReserveRatio;
+        emit ParameterUpdated("defaultReserveRatio");
     }
 
     /**
@@ -133,6 +134,7 @@ contract Curation is Governed, BancorFormula {
      */
     function setStaking(address _staking) external onlyGovernor {
         staking = _staking;
+        emit ParameterUpdated("staking");
     }
 
     /**
@@ -151,6 +153,7 @@ contract Curation is Governed, BancorFormula {
     function _setMinimumCurationStake(uint256 _minimumCurationStake) private {
         require(_minimumCurationStake > 0, "Minimum curation stake cannot be 0");
         minimumCurationStake = _minimumCurationStake;
+        emit ParameterUpdated("minimumCurationStake");
     }
 
     /**

contracts/DisputeManager.sol

@@ -238,6 +238,7 @@ contract DisputeManager is Governed {
      */
     function setArbitrator(address _arbitrator) external onlyGovernor {
         arbitrator = _arbitrator;
+        emit ParameterUpdated("arbitrator");
     }
 
     /**
@@ -247,6 +248,7 @@ contract DisputeManager is Governed {
      */
     function setMinimumDeposit(uint256 _minimumDeposit) external onlyGovernor {
         minimumDeposit = _minimumDeposit;
+        emit ParameterUpdated("minimumDeposit");
     }
 
     /**
@@ -258,6 +260,7 @@ contract DisputeManager is Governed {
         // Must be within 0% to 100% (inclusive)
         require(_percentage <= MAX_PPM, "Reward percentage must be below or equal to MAX_PPM");
         fishermanRewardPercentage = _percentage;
+        emit ParameterUpdated("fishermanRewardPercentage");
     }
 
     /**
@@ -268,6 +271,7 @@ contract DisputeManager is Governed {
         // Must be within 0% to 100% (inclusive)
         require(_percentage <= MAX_PPM, "Slashing percentage must be below or equal to MAX_PPM");
         slashingPercentage = _percentage;
+        emit ParameterUpdated("slashingPercentage");
     }
 
     /**
@@ -277,6 +281,7 @@ contract DisputeManager is Governed {
      */
     function setStaking(Staking _staking) external onlyGovernor {
         staking = _staking;
+        emit ParameterUpdated("staking");
     }
 
     /**

contracts/Governed.sol

@@ -11,6 +11,7 @@ contract Governed {
     address public governor;
 
     event OwnershipTransferred(address indexed from, address indexed to);
+    event ParameterUpdated(string param);
 
     modifier onlyGovernor {
         require(msg.sender == governor, "Only Governor can call");

contracts/Staking.sol

@@ -43,8 +43,8 @@ contract Staking is Governed {
     // Need to pass this period to claim fees in rebate pool
     uint256 public channelDisputeEpochs;
 
-    // Need to pass this period for delegators to settle
-    uint256 public maxSettlementEpochs;
+    // Maximum allocation time
+    uint256 public maxAllocationEpochs;
 
     // Time in blocks to unstake
     uint256 public thawingPeriod; // in blocks
@@ -121,7 +121,9 @@ contract Staking is Governed {
         uint256 epoch,
         uint256 tokens,
         address channelID,
-        address from
+        address from,
+        uint256 curationFees,
+        uint256 rebateFees
     );
 
     /**
@@ -173,6 +175,7 @@ contract Staking is Governed {
      */
     function setCuration(Curation _curation) external onlyGovernor {
         curation = _curation;
+        emit ParameterUpdated("curation");
     }
 
     /**
@@ -183,6 +186,7 @@ contract Staking is Governed {
         // Must be within 0% to 100% (inclusive)
         require(_percentage <= MAX_PPM, "Curation percentage must be below or equal to MAX_PPM");
         curationPercentage = _percentage;
+        emit ParameterUpdated("curationPercentage");
     }
 
     /**
@@ -191,14 +195,16 @@ contract Staking is Governed {
      */
     function setChannelDisputeEpochs(uint256 _channelDisputeEpochs) external onlyGovernor {
         channelDisputeEpochs = _channelDisputeEpochs;
+        emit ParameterUpdated("channelDisputeEpochs");
     }
 
     /**
-     * @dev Set the max settlement time allowed for indexers
-     * @param _maxSettlementEpochs Settlement duration limit in epochs
+     * @dev Set the max allocation time allowed for indexers
+     * @param _maxAllocationEpochs Allocation duration limit in epochs
      */
-    function setMaxSettlementEpochs(uint256 _maxSettlementEpochs) external onlyGovernor {
-        maxSettlementEpochs = _maxSettlementEpochs;
+    function setMaxAllocationEpochs(uint256 _maxAllocationEpochs) external onlyGovernor {
+        maxAllocationEpochs = _maxAllocationEpochs;
+        emit ParameterUpdated("maxAllocationEpochs");
     }
 
     /**
@@ -217,6 +223,7 @@ contract Staking is Governed {
      */
     function setThawingPeriod(uint256 _thawingPeriod) external onlyGovernor {
         thawingPeriod = _thawingPeriod;
+        emit ParameterUpdated("thawingPeriod");
     }
 
     /**
@@ -313,6 +320,10 @@ contract Staking is Governed {
         emit StakeSlashed(_indexer, _tokens, _reward, _beneficiary);
     }
 
+    /**
+     * @dev Deposit tokens on the indexer stake
+     * @param _tokens Amount of tokens to stake
+     */
     function stake(uint256 _tokens) external {
         address indexer = msg.sender;
 
@@ -523,7 +534,7 @@ contract Staking is Governed {
             indexer,
             subgraphID,
             rebateFees,
-            alloc.getTokensEffectiveAllocation(epochs, maxSettlementEpochs)
+            alloc.getTokensEffectiveAllocation(epochs, maxAllocationEpochs)
         );
 
         // Close channel
@@ -541,7 +552,16 @@ contract Staking is Governed {
             curation.collect(subgraphID, curationFees);
         }
 
-        emit AllocationSettled(indexer, subgraphID, currentEpoch, _tokens, _channelID, _from);
+        emit AllocationSettled(
+            indexer,
+            subgraphID,
+            currentEpoch,
+            _tokens,
+            _channelID,
+            _from,
+            rebateFees,
+            curationFees
+        );
     }
 
     /**

migrations/2_deploy_contracts.js

@@ -60,8 +60,8 @@ module.exports = async (deployer, network, accounts) => {
       log('   Configuring Contracts')
       log('   ---------------------')
       await executeAndLog(
-        staking.setMaxSettlementEpochs(config.staking.maxSettlementEpochs),
-        '   > Staking -> Set maxSettlementEpochs: ',
+        staking.setMaxAllocationEpochs(config.staking.maxAllocationEpochs),
+        '   > Staking -> Set maxAllocationEpochs: ',
       )
       await executeAndLog(
         staking.setThawingPeriod(config.staking.thawingPeriod),

migrations/deploy.config.js

@@ -19,7 +19,7 @@ module.exports = {
   },
   staking: {
     channelDisputeEpochs: 1,
-    maxSettlementEpochs: 5,
+    maxAllocationEpochs: 5,
     thawingPeriod: 20, // in blocks
   },
   token: {

test/lib/deployment.js

@@ -47,7 +47,7 @@ function deployServiceRegistry(owner) {
 async function deployStakingContract(owner, graphToken, epochManager, curation, params) {
   const contract = await Staking.new(owner, graphToken, epochManager, curation, params)
   await contract.setChannelDisputeEpochs(defaults.staking.channelDisputeEpochs, { from: owner })
-  await contract.setMaxSettlementEpochs(defaults.staking.maxSettlementEpochs, { from: owner })
+  await contract.setMaxAllocationEpochs(defaults.staking.maxAllocationEpochs, { from: owner })
   await contract.setThawingPeriod(defaults.staking.thawingPeriod, { from: owner })
   return contract
 }

test/lib/testHelpers.js

@@ -286,7 +286,7 @@ module.exports = {
     },
     staking: {
       channelDisputeEpochs: 1,
-      maxSettlementEpochs: 5,
+      maxAllocationEpochs: 5,
       thawingPeriod: 20, // in blocks
     },
     token: {

test/staking/general.test.js

@@ -130,17 +130,17 @@ contract('Staking', ([me, other, governor, indexer, slasher, fisherman]) => {
       })
     })
 
-    describe('maxSettlementEpochs', function() {
-      it('should set `maxSettlementEpochs`', async function() {
+    describe('maxAllocationEpochs', function() {
+      it('should set `maxAllocationEpochs`', async function() {
         const newValue = new BN(5)
-        await this.staking.setMaxSettlementEpochs(newValue, { from: governor })
-        expect(await this.staking.maxSettlementEpochs()).to.be.bignumber.eq(newValue)
+        await this.staking.setMaxAllocationEpochs(newValue, { from: governor })
+        expect(await this.staking.maxAllocationEpochs()).to.be.bignumber.eq(newValue)
       })
 
-      it('reject set `maxSettlementEpochs` if not allowed', async function() {
+      it('reject set `maxAllocationEpochs` if not allowed', async function() {
         const newValue = new BN(5)
         await expectRevert(
-          this.staking.setMaxSettlementEpochs(newValue, { from: other }),
+          this.staking.setMaxAllocationEpochs(newValue, { from: other }),
           'Only Governor can call',
         )
       })