misc: add missing interfaces

Author: abarmat

contracts/discovery/GNS.sol

@@ -6,6 +6,7 @@ import "@openzeppelin/contracts/math/SafeMath.sol";
 import "../governance/Managed.sol";
 import "../bancor/BancorFormula.sol";
 
+import "./IGNS.sol";
 import "./erc1056/IEthereumDIDRegistry.sol";
 
 /**
@@ -15,21 +16,11 @@ import "./erc1056/IEthereumDIDRegistry.sol";
  * Each version is associated with a Subgraph Deployment. The contract no knowledge of human
  * readable names. All human readable names emitted in events.
  */
-contract GNS is Managed {
+contract GNS is Managed, IGNS {
     using SafeMath for uint256;
 
     // -- State --
 
-    struct NameCurationPool {
-        uint256 vSignal; // The token of the subgraph deployment bonding curve
-        uint256 nSignal; // The token of the name curation bonding curve
-        mapping(address => uint256) curatorNSignal;
-        bytes32 subgraphDeploymentID;
-        uint32 reserveRatio;
-        bool disabled;
-        uint256 withdrawableGRT;
-    }
-
     // Equates to Connector weight on bancor formula to be CW = 1
     uint32 private constant defaultReserveRatio = 1000000;
 
@@ -191,7 +182,7 @@ contract GNS is Managed {
     /**
      * @dev Approve curation contract to pull funds.
      */
-    function approveAll() external onlyGovernor {
+    function approveAll() external override onlyGovernor {
         graphToken().approve(address(curation()), uint256(-1));
     }
 
@@ -200,7 +191,7 @@ contract GNS is Managed {
      * @notice Update the minimum vSignal amount to `_minimumVSignalStake`
      * @param _minimumVSignalStake Minimum amount of vSignal required
      */
-    function setMinimumVsignal(uint256 _minimumVSignalStake) external onlyGovernor {
+    function setMinimumVsignal(uint256 _minimumVSignalStake) external override onlyGovernor {
         require(_minimumVSignalStake > 0, "Minimum vSignal cannot be 0");
         minimumVSignalStake = _minimumVSignalStake;
         emit ParameterUpdated("minimumVSignalStake");
@@ -211,7 +202,7 @@ contract GNS is Managed {
      * the name curators tokens while upgrading or deprecating and is configurable in parts per hundred.
      * @param _ownerFeePercentage Owner fee percentage
      */
-    function setOwnerFeePercentage(uint32 _ownerFeePercentage) external onlyGovernor {
+    function setOwnerFeePercentage(uint32 _ownerFeePercentage) external override onlyGovernor {
         require(_ownerFeePercentage <= 100, "Owner fee must be 100 or less");
         ownerFeePercentage = _ownerFeePercentage;
         emit ParameterUpdated("ownerFeePercentage");
@@ -229,7 +220,7 @@ contract GNS is Managed {
         uint8 _nameSystem,
         bytes32 _nameIdentifier,
         string calldata _name
-    ) external onlyGraphAccountOwner(_graphAccount) {
+    ) external override onlyGraphAccountOwner(_graphAccount) {
         emit SetDefaultName(_graphAccount, _nameSystem, _nameIdentifier, _name);
     }
 
@@ -243,7 +234,7 @@ contract GNS is Managed {
         address _graphAccount,
         uint256 _subgraphNumber,
         bytes32 _subgraphMetadata
-    ) public onlyGraphAccountOwner(_graphAccount) {
+    ) public override onlyGraphAccountOwner(_graphAccount) {
         emit SubgraphMetadataUpdated(_graphAccount, _subgraphNumber, _subgraphMetadata);
     }
 
@@ -260,7 +251,7 @@ contract GNS is Managed {
         bytes32 _subgraphDeploymentID,
         bytes32 _versionMetadata,
         bytes32 _subgraphMetadata
-    ) external onlyGraphAccountOwner(_graphAccount) {
+    ) external override onlyGraphAccountOwner(_graphAccount) {
         uint256 subgraphNumber = graphAccountSubgraphNumbers[_graphAccount];
         _publishVersion(_graphAccount, subgraphNumber, _subgraphDeploymentID, _versionMetadata);
         graphAccountSubgraphNumbers[_graphAccount]++;
@@ -282,7 +273,7 @@ contract GNS is Managed {
         uint256 _subgraphNumber,
         bytes32 _subgraphDeploymentID,
         bytes32 _versionMetadata
-    ) external onlyGraphAccountOwner(_graphAccount) {
+    ) external override onlyGraphAccountOwner(_graphAccount) {
         require(
             isPublished(_graphAccount, _subgraphNumber),
             "GNS: Cannot update version if not published, or has been deprecated"
@@ -329,6 +320,7 @@ contract GNS is Managed {
      */
     function deprecateSubgraph(address _graphAccount, uint256 _subgraphNumber)
         external
+        override
         onlyGraphAccountOwner(_graphAccount)
     {
         require(
@@ -417,7 +409,7 @@ contract GNS is Managed {
         address _graphAccount,
         uint256 _subgraphNumber,
         uint256 _tokens
-    ) external {
+    ) external override {
         NameCurationPool storage namePool = nameSignals[_graphAccount][_subgraphNumber];
         require(namePool.disabled == false, "GNS: Cannot be disabled");
         require(
@@ -437,7 +429,7 @@ contract GNS is Managed {
         address _graphAccount,
         uint256 _subgraphNumber,
         uint256 _nSignal
-    ) external {
+    ) external override {
         address nameCurator = msg.sender;
         NameCurationPool storage namePool = nameSignals[_graphAccount][_subgraphNumber];
         uint256 curatorNSignal = namePool.curatorNSignal[nameCurator];
@@ -479,7 +471,7 @@ contract GNS is Managed {
      * @param _graphAccount Subgraph owner
      * @param _subgraphNumber Subgraph owners subgraph number which was curated on by nameCurators
      */
-    function withdraw(address _graphAccount, uint256 _subgraphNumber) external {
+    function withdraw(address _graphAccount, uint256 _subgraphNumber) external override {
         NameCurationPool storage namePool = nameSignals[_graphAccount][_subgraphNumber];
         require(namePool.disabled == true, "GNS: Name bonding curve must be disabled first");
         require(namePool.withdrawableGRT > 0, "GNS: No more GRT to withdraw");
@@ -606,7 +598,7 @@ contract GNS is Managed {
         address _graphAccount,
         uint256 _subgraphNumber,
         uint256 _tokens
-    ) public view returns (uint256, uint256) {
+    ) public override view returns (uint256, uint256) {
         NameCurationPool memory namePool = nameSignals[_graphAccount][_subgraphNumber];
         uint256 vSignal = curation().tokensToSignal(namePool.subgraphDeploymentID, _tokens);
         uint256 nSignal = vSignalToNSignal(_graphAccount, _subgraphNumber, vSignal);
@@ -626,6 +618,7 @@ contract GNS is Managed {
         uint256 _nSignal
     )
         public
+        override
         view
         returns (
             uint256,
@@ -653,7 +646,7 @@ contract GNS is Managed {
         address _graphAccount,
         uint256 _subgraphNumber,
         uint256 _vSignal
-    ) public view returns (uint256) {
+    ) public override view returns (uint256) {
         NameCurationPool memory namePool = nameSignals[_graphAccount][_subgraphNumber];
         uint256 vSignal = _vSignal;
 
@@ -690,7 +683,7 @@ contract GNS is Managed {
         address _graphAccount,
         uint256 _subgraphNumber,
         uint256 _nSignal
-    ) public view returns (uint256) {
+    ) public override view returns (uint256) {
         NameCurationPool memory namePool = nameSignals[_graphAccount][_subgraphNumber];
         return
             BancorFormula(bondingCurve).calculateSaleReturn(
@@ -712,7 +705,7 @@ contract GNS is Managed {
         address _graphAccount,
         uint256 _subgraphNumber,
         address _curator
-    ) public view returns (uint256) {
+    ) public override view returns (uint256) {
         return nameSignals[_graphAccount][_subgraphNumber].curatorNSignal[_curator];
     }
 
@@ -724,6 +717,7 @@ contract GNS is Managed {
      */
     function isPublished(address _graphAccount, uint256 _subgraphNumber)
         public
+        override
         view
         returns (bool)
     {

contracts/discovery/IGNS.sol

@@ -0,0 +1,114 @@
+pragma solidity ^0.6.12;
+
+interface IGNS {
+    // -- Pool --
+
+    struct NameCurationPool {
+        uint256 vSignal; // The token of the subgraph deployment bonding curve
+        uint256 nSignal; // The token of the name curation bonding curve
+        mapping(address => uint256) curatorNSignal;
+        bytes32 subgraphDeploymentID;
+        uint32 reserveRatio;
+        bool disabled;
+        uint256 withdrawableGRT;
+    }
+
+    // -- Configuration --
+
+    function approveAll() external;
+
+    function setMinimumVsignal(uint256 _minimumVSignalStake) external;
+
+    function setOwnerFeePercentage(uint32 _ownerFeePercentage) external;
+
+    // -- Publishing --
+
+    function setDefaultName(
+        address _graphAccount,
+        uint8 _nameSystem,
+        bytes32 _nameIdentifier,
+        string calldata _name
+    ) external;
+
+    function updateSubgraphMetadata(
+        address _graphAccount,
+        uint256 _subgraphNumber,
+        bytes32 _subgraphMetadata
+    ) external;
+
+    function publishNewSubgraph(
+        address _graphAccount,
+        bytes32 _subgraphDeploymentID,
+        bytes32 _versionMetadata,
+        bytes32 _subgraphMetadata
+    ) external;
+
+    function publishNewVersion(
+        address _graphAccount,
+        uint256 _subgraphNumber,
+        bytes32 _subgraphDeploymentID,
+        bytes32 _versionMetadata
+    ) external;
+
+    function deprecateSubgraph(address _graphAccount, uint256 _subgraphNumber) external;
+
+    // -- Curation --
+
+    function mintNSignal(
+        address _graphAccount,
+        uint256 _subgraphNumber,
+        uint256 _tokens
+    ) external;
+
+    function burnNSignal(
+        address _graphAccount,
+        uint256 _subgraphNumber,
+        uint256 _nSignal
+    ) external;
+
+    function withdraw(address _graphAccount, uint256 _subgraphNumber) external;
+
+    // -- Getters --
+
+    function tokensToNSignal(
+        address _graphAccount,
+        uint256 _subgraphNumber,
+        uint256 _tokens
+    ) external view returns (uint256, uint256);
+
+    function nSignalToTokens(
+        address _graphAccount,
+        uint256 _subgraphNumber,
+        uint256 _nSignal
+    )
+        external
+        view
+        returns (
+            uint256,
+            uint256,
+            uint256
+        );
+
+    function vSignalToNSignal(
+        address _graphAccount,
+        uint256 _subgraphNumber,
+        uint256 _vSignal
+    ) external view returns (uint256);
+
+    function nSignalToVSignal(
+        address _graphAccount,
+        uint256 _subgraphNumber,
+        uint256 _nSignal
+    ) external view returns (uint256);
+
+    function getCuratorNSignal(
+        address _graphAccount,
+        uint256 _subgraphNumber,
+        address _curator
+    ) external view returns (uint256);
+
+    function isPublished(address _graphAccount, uint256 _subgraphNumber)
+        external
+        view
+        returns (bool);
+}

contracts/discovery/IServiceRegistry.sol

@@ -0,0 +1,14 @@
+pragma solidity ^0.6.12;
+
+interface IServiceRegistry {
+    struct IndexerService {
+        string url;
+        string geohash;
+    }
+
+    function register(string calldata _url, string calldata _geohash) external;
+
+    function unregister() external;
+
+    function isRegistered(address _indexer) external view returns (bool);
+}

contracts/discovery/ServiceRegistry.sol

@@ -1,19 +1,16 @@
 pragma solidity ^0.6.12;
 pragma experimental ABIEncoderV2;
 
+import "./IServiceRegistry.sol";
+
 /**
  * @title ServiceRegistry contract
  * @dev This contract supports the service discovery process by allowing indexers to
  * register their service url and any other relevant information.
  */
-contract ServiceRegistry {
+contract ServiceRegistry is IServiceRegistry {
     // -- State --
 
-    struct IndexerService {
-        string url;
-        string geohash;
-    }
-
     mapping(address => IndexerService) public services;
 
     // -- Events --
@@ -26,7 +23,7 @@ contract ServiceRegistry {
      * @param _url URL of the indexer service
      * @param _geohash Geohash of the indexer service location
      */
-    function register(string calldata _url, string calldata _geohash) external {
+    function register(string calldata _url, string calldata _geohash) external override {
         address indexer = msg.sender;
         require(bytes(_url).length > 0, "Service must specify a URL");
 
@@ -38,7 +35,7 @@ contract ServiceRegistry {
     /**
      * @dev Unregister an indexer service
      */
-    function unregister() external {
+    function unregister() external override {
         address indexer = msg.sender;
         require(isRegistered(indexer), "Service already unregistered");
 
@@ -50,7 +47,7 @@ contract ServiceRegistry {
      * @dev Return the registration status of an indexer service
      * @return True if the indexer service is registered
      */
-    function isRegistered(address _indexer) public view returns (bool) {
+    function isRegistered(address _indexer) public override view returns (bool) {
         return bytes(services[_indexer].url).length > 0;
     }
 }