curation: rename graph signal token to graph curation share

Author: abarmat

.soliumignore

@@ -6,6 +6,6 @@ contracts/token/IGraphToken.sol
 contracts/upgrades/GraphProxy.sol
 contracts/rewards/RewardsManager.sol
 contracts/tests/ens
-contracts/curation/IGraphSignalToken.sol
+contracts/curation/IGraphCurationToken.sol
 contracts/staking/libs/LibFixedMath.sol
 contracts/tests/testnet/GSRManager.sol

contracts/curation/Curation.sol

@@ -7,7 +7,7 @@ import "../upgrades/GraphUpgradeable.sol";
 
 import "./CurationStorage.sol";
 import "./ICuration.sol";
-import "./GraphSignalToken.sol";
+import "./GraphCurationToken.sol";
 
 /**
  * @title Curation contract
@@ -16,9 +16,9 @@ import "./GraphSignalToken.sol";
  * subgraph deployment they curate.
  * A curators deposit goes to a curation pool along with the deposits of other curators,
  * only one such pool exists for each subgraph deployment.
- * The contract mints Graph Signal Tokens (GST) according to a bonding curve for each individual
+ * The contract mints Graph Curation Shares (GCS) according to a bonding curve for each individual
  * curation pool where GRT is deposited.
- * Holders can burn GST tokens using this contract to get GRT tokens back according to the
+ * Holders can burn GCS using this contract to get GRT tokens back according to the
  * bonding curve.
  */
 contract Curation is CurationV1Storage, GraphUpgradeable, ICuration {
@@ -196,11 +196,11 @@ contract Curation is CurationV1Storage, GraphUpgradeable, ICuration {
             curationPool.reserveRatio = defaultReserveRatio;
 
             // If no signal token for the pool - create one
-            if (address(curationPool.gst) == address(0)) {
+            if (address(curationPool.gcs) == address(0)) {
                 // TODO: the gas cost of deploying the subgraph token can be greatly optimized
                 // by deploying a proxy each time, sharing the same implementation
-                curationPool.gst = IGraphSignalToken(
-                    address(new GraphSignalToken("GST", address(this)))
+                curationPool.gcs = IGraphCurationToken(
+                    address(new GraphCurationToken(address(this)))
                 );
             }
         }
@@ -216,7 +216,7 @@ contract Curation is CurationV1Storage, GraphUpgradeable, ICuration {
             "Cannot transfer tokens to deposit"
         );
 
-        // Exchange GRT tokens for GST of the subgraph pool
+        // Exchange GRT tokens for GCS of the subgraph pool
         uint256 signal = _mintSignal(curator, _subgraphDeploymentID, _tokens);
 
         emit Signalled(curator, _subgraphDeploymentID, _tokens, signal);
@@ -293,10 +293,10 @@ contract Curation is CurationV1Storage, GraphUpgradeable, ICuration {
         view
         returns (uint256)
     {
-        if (address(pools[_subgraphDeploymentID].gst) == address(0)) {
+        if (address(pools[_subgraphDeploymentID].gcs) == address(0)) {
             return 0;
         }
-        return pools[_subgraphDeploymentID].gst.balanceOf(_curator);
+        return pools[_subgraphDeploymentID].gcs.balanceOf(_curator);
     }
 
     /**
@@ -310,10 +310,10 @@ contract Curation is CurationV1Storage, GraphUpgradeable, ICuration {
         view
         returns (uint256)
     {
-        if (address(pools[_subgraphDeploymentID].gst) == address(0)) {
+        if (address(pools[_subgraphDeploymentID].gcs) == address(0)) {
             return 0;
         }
-        return pools[_subgraphDeploymentID].gst.totalSupply();
+        return pools[_subgraphDeploymentID].gcs.totalSupply();
     }
 
     /**
@@ -424,7 +424,7 @@ contract Curation is CurationV1Storage, GraphUpgradeable, ICuration {
         // Update GRT tokens held as reserves
         curationPool.tokens = curationPool.tokens.add(_tokens);
         // Mint signal to the curator
-        curationPool.gst.mint(_curator, signal);
+        curationPool.gcs.mint(_curator, signal);
 
         return signal;
     }
@@ -449,7 +449,7 @@ contract Curation is CurationV1Storage, GraphUpgradeable, ICuration {
         // Update GRT tokens held as reserves
         curationPool.tokens = curationPool.tokens.sub(outTokens);
         // Burn signal from curator
-        curationPool.gst.burnFrom(_curator, _signal);
+        curationPool.gcs.burnFrom(_curator, _signal);
 
         return (tokens, withdrawalFees);
     }

contracts/curation/GraphSignalToken.sol renamed to contracts/curation/GraphCurationToken.sol

@@ -5,20 +5,19 @@ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 import "../governance/Governed.sol";
 
 /**
- * @title GraphSignalToken contract
- * @dev This is the implementation of the Curation Signal ERC20 token (GST).
- * GST tokens are created for each subgraph deployment curated in the Curation contract.
- * The Curation contract is the owner of GST tokens and the only one allowed to mint or
- * burn them. GST tokens are transferrable and their holders can do any action allowed
+ * @title GraphCurationToken contract
+ * @dev This is the implementation of the Curation ERC20 token (GCS).
+ * GCS are created for each subgraph deployment curated in the Curation contract.
+ * The Curation contract is the owner of GCS tokens and the only one allowed to mint or
+ * burn them. GCS tokens are transferrable and their holders can do any action allowed
  * in a standard ERC20 token implementation except for burning them.
  */
-contract GraphSignalToken is ERC20, Governed {
+contract GraphCurationToken is ERC20, Governed {
     /**
-     * @dev Graph Token Contract Constructor.
-     * @param _symbol Token symbol
+     * @dev Graph Curation Token Contract Constructor.
      * @param _owner Address of the contract issuing this token
      */
-    constructor(string memory _symbol, address _owner) public ERC20("Graph Signal Token", _symbol) {
+    constructor(address _owner) public ERC20("Graph Curation Share", "GCS") {
         Governed._initialize(_owner);
     }
 

contracts/curation/ICuration.sol

@@ -1,14 +1,14 @@
 pragma solidity ^0.6.12;
 
-import "./IGraphSignalToken.sol";
+import "./IGraphCurationToken.sol";
 
 interface ICuration {
     // -- Pool --
 
     struct CurationPool {
         uint256 tokens; // GRT Tokens stored as reserves for the subgraph deployment
         uint32 reserveRatio; // Ratio for the bonding curve
-        IGraphSignalToken gst; // Signal token contract for this curation pool
+        IGraphCurationToken gcs; // Curation token contract for this curation pool
     }
 
     // -- Configuration --

contracts/curation/IGraphSignalToken.sol renamed to contracts/curation/IGraphCurationToken.sol

@@ -2,7 +2,7 @@ pragma solidity ^0.6.12;
 
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
-interface IGraphSignalToken is IERC20 {
+interface IGraphCurationToken is IERC20 {
     function burnFrom(address _account, uint256 _amount) external;
 
     function mint(address _to, uint256 _amount) external;

contracts/discovery/GNS.sol

@@ -335,7 +335,6 @@ contract GNS is Managed {
             isPublished(_graphAccount, _subgraphNumber),
             "GNS: Cannot deprecate a subgraph which does not exist"
         );
-        bytes32 subgraphDeploymentID = subgraphs[_graphAccount][_subgraphNumber];
         delete subgraphs[_graphAccount][_subgraphNumber];
         emit SubgraphDeprecated(_graphAccount, _subgraphNumber);
 
@@ -457,10 +456,7 @@ contract GNS is Managed {
      * @param _graphAccount Account that is deprecating their name curation
      * @param _subgraphNumber Subgraph number
      */
-    function _disableNameSignal(
-        address _graphAccount,
-        uint256 _subgraphNumber
-    ) private {
+    function _disableNameSignal(address _graphAccount, uint256 _subgraphNumber) private {
         NameCurationPool storage namePool = nameSignals[_graphAccount][_subgraphNumber];
         // If no nSignal, then no need to burn vSignal
         if (namePool.nSignal != 0) {

test/curation/curation.test.ts

@@ -444,7 +444,7 @@ describe('Curation', () => {
     it('should mint less signal every time due to the bonding curve', async function () {
       const tokensToDepositMany = [
         toGRT('1000'), // should mint if we start with number above minimum deposit
-        toGRT('1000'), // every time it should mint less GST due to bonding curve...
+        toGRT('1000'), // every time it should mint less GCS due to bonding curve...
         toGRT('1000'),
         toGRT('1000'),
         toGRT('2000'),
@@ -471,13 +471,13 @@ describe('Curation', () => {
     })
 
     it('should mint when using the edge case of linear function', async function () {
-      // Setup edge case like linear function: 1 GRT = 1 GST
+      // Setup edge case like linear function: 1 GRT = 1 GCS
       await curation.setMinimumCurationDeposit(toGRT('1'))
       await curation.setDefaultReserveRatio(1000000)
 
       const tokensToDepositMany = [
         toGRT('1000'), // should mint if we start with number above minimum deposit
-        toGRT('1000'), // every time it should mint less GST due to bonding curve...
+        toGRT('1000'), // every time it should mint less GCS due to bonding curve...
         toGRT('1000'),
         toGRT('1000'),
         toGRT('2000'),

test/gns.test.ts

@@ -838,7 +838,7 @@ describe('GNS', () => {
       it('should mint less signal every time due to the bonding curve', async function () {
         const tokensToDepositMany = [
           toGRT('1000'), // should mint if we start with number above minimum deposit
-          toGRT('1000'), // every time it should mint less GST due to bonding curve...
+          toGRT('1000'), // every time it should mint less GCS due to bonding curve...
           toGRT('1'), // should mint below minimum deposit
           toGRT('1000'),
           toGRT('1000'),
@@ -881,7 +881,7 @@ describe('GNS', () => {
 
         const tokensToDepositMany = [
           toGRT('1000'), // should mint if we start with number above minimum deposit
-          toGRT('1000'), // every time it should mint less GST due to bonding curve...
+          toGRT('1000'), // every time it should mint less GCS due to bonding curve...
           toGRT('1000'),
           toGRT('1000'),
           toGRT('2000'),