style: update name conventions for indexer and governance (#171)

Author: abarmat

contracts/Curation.sol

@@ -3,7 +3,7 @@ pragma experimental ABIEncoderV2;
 
 /*
  * @title Curation contract
- * @notice Allows Curators to signal Subgraphs that are relevant for indexers and earn fees from the Query Market.
+ * @notice Allows Curators to signal Subgraphs that are relevant for indexers and earn fees from the Query Market
  */
 
 import "./Governed.sol";
@@ -12,6 +12,7 @@ import "./bancor/BancorFormula.sol";
 import "./bytes/BytesLib.sol";
 import "@openzeppelin/contracts/math/SafeMath.sol";
 
+
 contract Curation is Governed, BancorFormula {
     using BytesLib for bytes;
     using SafeMath for uint256;
@@ -102,7 +103,7 @@ contract Curation is Governed, BancorFormula {
      */
     function setDefaultReserveRatio(uint256 _defaultReserveRatio)
         external
-        onlyGovernance
+        onlyGovernor
     {
         _setDefaultReserveRatio(_defaultReserveRatio);
     }
@@ -127,7 +128,7 @@ contract Curation is Governed, BancorFormula {
      * @notice Update the distributor address to `_distributor`
      * @param _distributor <address> - Address of the party doing fee distributions
      */
-    function setDistributor(address _distributor) external onlyGovernance {
+    function setDistributor(address _distributor) external onlyGovernor {
         _setDistributor(_distributor);
     }
 
@@ -147,7 +148,7 @@ contract Curation is Governed, BancorFormula {
      */
     function setMinimumCurationStake(uint256 _minimumCurationStake)
         external
-        onlyGovernance
+        onlyGovernor
     {
         _setMinimumCurationStake(_minimumCurationStake);
     }
@@ -205,7 +206,10 @@ contract Curation is Governed, BancorFormula {
     function unstake(bytes32 _subgraphID, uint256 _shares) external {
         address curator = msg.sender;
         Subgraph storage subgraph = subgraphs[_subgraphID];
-        SubgraphCurator storage subgraphCurator = subgraphCurators[_subgraphID][curator];
+
+
+            SubgraphCurator storage subgraphCurator
+         = subgraphCurators[_subgraphID][curator];
 
         require(_shares > 0, "Cannot unstake zero shares");
         require(
@@ -260,20 +264,20 @@ contract Curation is Governed, BancorFormula {
     }
 
     /**
-      * @dev Check if any Graph tokens are staked for a particular subgraph
-      * @param _subgraphID <uint256> Subgraph ID to check if tokens are staked
-      * @return <bool> True if the subgraph is curated
-      */
+     * @dev Check if any Graph tokens are staked for a particular subgraph
+     * @param _subgraphID <uint256> Subgraph ID to check if tokens are staked
+     * @return <bool> True if the subgraph is curated
+     */
     function isSubgraphCurated(bytes32 _subgraphID) public view returns (bool) {
         return subgraphs[_subgraphID].totalTokens > 0;
     }
 
     /**
-      * @dev Calculate number of subgraph shares that can be bought with a number of tokens
-      * @param _subgraphID <bytes32> Subgraph ID from where to buy shares
-      * @param _tokens <uint256> Amount of tokens used to buy shares
-      * @return <uint256> Amount of shares that can be bought
-      */
+     * @dev Calculate number of subgraph shares that can be bought with a number of tokens
+     * @param _subgraphID <bytes32> Subgraph ID from where to buy shares
+     * @param _tokens <uint256> Amount of tokens used to buy shares
+     * @return <uint256> Amount of shares that can be bought
+     */
     function subgraphTokensToShares(bytes32 _subgraphID, uint256 _tokens)
         public
         view
@@ -293,16 +297,15 @@ contract Curation is Governed, BancorFormula {
                 subgraph.totalTokens,
                 uint32(subgraph.reserveRatio),
                 _tokens
-            ) +
-            shares;
+            ) + shares;
     }
 
     /**
-      * @dev Calculate number of tokens to get when selling subgraph shares
-      * @param _subgraphID <bytes32> Subgraph ID from where to sell shares
-      * @param _shares <uint256> Amount of shares to sell
-      * @return <uint256> Amount of tokens to get after selling shares
-      */
+     * @dev Calculate number of tokens to get when selling subgraph shares
+     * @param _subgraphID <bytes32> Subgraph ID from where to sell shares
+     * @param _shares <uint256> Amount of shares to sell
+     * @return <uint256> Amount of tokens to get after selling shares
+     */
     function subgraphSharesToTokens(bytes32 _subgraphID, uint256 _shares)
         public
         view
@@ -375,7 +378,10 @@ contract Curation is Governed, BancorFormula {
     {
         uint256 tokens = _amount;
         Subgraph storage subgraph = subgraphs[_subgraphID];
-        SubgraphCurator storage subgraphCurator = subgraphCurators[_subgraphID][_curator];
+
+
+            SubgraphCurator storage subgraphCurator
+         = subgraphCurators[_subgraphID][_curator];
 
         // If this subgraph hasn't been curated before then initialize the curve
         // Sets the initial slope for the curve, controlled by minimumCurationStake

contracts/DisputeManager.sol

@@ -12,6 +12,7 @@ import "./Staking.sol";
 import "./bytes/BytesLib.sol";
 import "@openzeppelin/contracts/cryptography/ECDSA.sol";
 
+
 contract DisputeManager is Governed {
     using BytesLib for bytes;
     using ECDSA for bytes32;
@@ -220,7 +221,7 @@ contract DisputeManager is Governed {
      * @notice Update the arbitrator to `_arbitrator`
      * @param _arbitrator <address> - The address of the arbitration contract or party
      */
-    function setArbitrator(address _arbitrator) external onlyGovernance {
+    function setArbitrator(address _arbitrator) external onlyGovernor {
         _setArbitrator(_arbitrator);
     }
 
@@ -242,10 +243,7 @@ contract DisputeManager is Governed {
      * @notice Update the minimum deposit to `_minimumDeposit` Graph Tokens
      * @param _minimumDeposit <uint256> - The minimum deposit in Graph Tokens
      */
-    function setMinimumDeposit(uint256 _minimumDeposit)
-        external
-        onlyGovernance
-    {
+    function setMinimumDeposit(uint256 _minimumDeposit) external onlyGovernor {
         minimumDeposit = _minimumDeposit;
     }
 
@@ -256,7 +254,7 @@ contract DisputeManager is Governed {
      */
     function setSlashingPercentage(uint256 _slashingPercentage)
         external
-        onlyGovernance
+        onlyGovernor
     {
         // Must be within 0% to 100% (inclusive)
         require(
@@ -328,7 +326,7 @@ contract DisputeManager is Governed {
 
         // Have staking slash the index node and reward the fisherman
         // Give the fisherman a reward equal to the slashingPercentage of the indexer's stake
-        uint256 stake = staking.getIndexingNodeStake(
+        uint256 stake = staking.getIndexNodeStake(
             dispute.subgraphID,
             dispute.indexNode
         );
@@ -433,7 +431,7 @@ contract DisputeManager is Governed {
         address indexNode = disputeID.recover(_sig);
 
         // Get staked amount on the served subgraph by indexer
-        uint256 stake = staking.getIndexingNodeStake(_subgraphID, indexNode);
+        uint256 stake = staking.getIndexNodeStake(_subgraphID, indexNode);
 
         // This also validates that indexer node exists
         require(

contracts/EpochManager.sol

@@ -53,7 +53,7 @@ contract EpochManager is Governed {
      * @notice Set epoch length to `_epochLength` blocks
      * @param _epochLength Epoch length in blocks
      */
-    function setEpochLength(uint256 _epochLength) external onlyGovernance {
+    function setEpochLength(uint256 _epochLength) external onlyGovernor {
         require(_epochLength > 0, "Epoch length cannot be 0");
         require(
             _epochLength != epochLength,

contracts/Governed.sol

@@ -1,32 +1,22 @@
 pragma solidity ^0.6.4;
+pragma experimental ABIEncoderV2;
 
-contract Governed {
-    /*
-     * @title Graph Contract Governance contract
-     *
-     * @author Bryant Eisenbach
-     * @author Reuven Etzion
-     *
-     * @notice Contract Specification:
-     *
-     * There are several parameters throughout this mechanism design which are set via a
-     * governance process. In the v1 specification, governance will consist of a small committee
-     * which enacts changes to the protocol via a multi-sig contract.
-     *
-     * Requirements ("Governed" contract):
-     * req 01 Multisig contract will own this contract
-     * req 02 Verify the Governed contracts can upgrade themselves to a new `governor`
-     *   (GovA owns contracts 1-5 and can transfer ownership of 1-5 to GovB)
-     * ...
-     * Version 2
-     * req 01 (V2) Change Mutli-sig to use a voting mechanism
-     *   - Majority of votes after N% of votes cast will trigger proposed actions
-     */
 
+/*
+ * @title Graph Governance contract
+ * @notice All contracts that will be owned by a Governor entity should extend this contract
+ */
+
+contract Governed {
     address public governor;
 
     event GovernanceTransferred(address indexed _from, address indexed _to);
 
+    modifier onlyGovernor {
+        require(msg.sender == governor, "Only Governor can call");
+        _;
+    }
+
     /**
      * @dev All `Governed` contracts are constructed using an address for the `governor`
      * @param _governor <address> Address of initial `governor` of the contract
@@ -35,18 +25,13 @@ contract Governed {
         governor = _governor;
     }
 
-    modifier onlyGovernance {
-        require(msg.sender == governor, "Only Governor can call");
-        _;
-    }
-
     /**
      * @dev The current `governor` can assign a new `governor`
      * @param _newGovernor <address> Address of new `governor`
      */
-    function transferGovernance(address _newGovernor)
+    function transferOwnership(address _newGovernor)
         public
-        onlyGovernance
+        onlyGovernor
         returns (bool)
     {
         governor = _newGovernor;

contracts/GraphToken.sol

@@ -10,6 +10,7 @@ import "./Governed.sol";
 import "@openzeppelin/contracts/token/ERC20/ERC20Burnable.sol";
 import "@openzeppelin/contracts/token/ERC20/ERC20Detailed.sol";
 
+
 // @imp 08 target _to of transfer(_to, _amount, _data) in Token must implement this interface
 // NOTE: This is based off of ERC777TokensRecipient interface, but does not fully implement it
 interface TokenReceiver {
@@ -20,6 +21,7 @@ interface TokenReceiver {
     ) external returns (bool);
 }
 
+
 contract GraphToken is Governed, ERC20Detailed, ERC20Burnable {
     mapping(address => bool) private _minters;
 
@@ -52,11 +54,11 @@ contract GraphToken is Governed, ERC20Detailed, ERC20Burnable {
         _mint(_governor, _initialSupply);
     }
 
-    function addMinter(address _account) external onlyGovernance {
+    function addMinter(address _account) external onlyGovernor {
         _addMinter(_account);
     }
 
-    function removeMinter(address _account) external onlyGovernance {
+    function removeMinter(address _account) external onlyGovernor {
         _removeMinter(_account);
     }
 

contracts/RewardsManager.sol

@@ -3,6 +3,7 @@ pragma experimental ABIEncoderV2;
 
 import "./Governed.sol";
 
+
 contract RewardsManager is Governed {
     /*
      * @title Graph Protocol Reward Manager contract
@@ -65,7 +66,7 @@ contract RewardsManager is Governed {
      */
     function updateCuratorRewardRate(uint256 _newCuratorRewardRate)
         public
-        onlyGovernance
+        onlyGovernor
         returns (bool success)
     {
         revert();
@@ -77,7 +78,7 @@ contract RewardsManager is Governed {
      */
     function updateTargetParticipationRate(uint256 _newTargetParticipationRate)
         public
-        onlyGovernance
+        onlyGovernor
         returns (bool success)
     {
         revert();
@@ -89,7 +90,7 @@ contract RewardsManager is Governed {
      */
     function updateYearlyInflationRate(uint256 _newYearlyInflationRate)
         public
-        onlyGovernance
+        onlyGovernor
         returns (bool success)
     {
         revert();
@@ -104,7 +105,7 @@ contract RewardsManager is Governed {
      */
     function mintRewardTokens(address _account, uint256 _value)
         public
-        onlyGovernance
+        onlyGovernor
         returns (bool success)
     {
         revert();

contracts/ServiceRegistry.sol

@@ -3,6 +3,7 @@ pragma experimental ABIEncoderV2;
 
 import "./Governed.sol";
 
+
 contract ServiceRegistry is Governed {
     /*
      * @title Graph Protocol Service Registry contract
@@ -46,7 +47,7 @@ contract ServiceRegistry is Governed {
      */
     function setBootstrapIndexerURL(address _indexer, string calldata _url)
         external
-        onlyGovernance
+        onlyGovernor
     {
         bytes memory url = bytes(_url);
         bootstrapIndexerURLs[_indexer] = url;