fix: standardize on format for deprecated variables

pcarranzav · pcarranzav · commit 6f2736065f52 · 2023-10-23T14:51:59.000-03:00
diff --git a/contracts/discovery/GNS.sol b/contracts/discovery/GNS.sol
@@ -257,7 +257,7 @@ abstract contract GNS is GNSV3Storage, GraphUpgradeable, IGNS, Multicall {
         uint256 subgraphID = _nextSubgraphID(subgraphOwner);
         SubgraphData storage subgraphData = _getSubgraphData(subgraphID);
         subgraphData.subgraphDeploymentID = _subgraphDeploymentID;
-        subgraphData.reserveRatioDeprecated = fixedReserveRatio;
+        subgraphData.__DEPRECATED_reserveRatio = fixedReserveRatio;
 
         // Mint the NFT. Use the subgraphID as tokenID.
         // This function will check the if tokenID already exists.
@@ -371,7 +371,7 @@ abstract contract GNS is GNSV3Storage, GraphUpgradeable, IGNS, Multicall {
         // Deprecate the subgraph and do cleanup
         subgraphData.disabled = true;
         subgraphData.vSignal = 0;
-        subgraphData.reserveRatioDeprecated = 0;
+        subgraphData.__DEPRECATED_reserveRatio = 0;
         // NOTE: We don't reset the following variable as we use it to test if the Subgraph was ever created
         // subgraphData.subgraphDeploymentID = 0;
 
diff --git a/contracts/discovery/IGNS.sol b/contracts/discovery/IGNS.sol
@@ -18,7 +18,7 @@ interface IGNS {
         uint256 nSignal; // The token of the subgraph bonding curve
         mapping(address => uint256) curatorNSignal;
         bytes32 subgraphDeploymentID;
-        uint32 reserveRatioDeprecated; // Ratio for the bonding curve, always 1 in PPM, deprecated.
+        uint32 __DEPRECATED_reserveRatio; // solhint-disable-line var-name-mixedcase
         bool disabled;
         uint256 withdrawableGRT;
     }
diff --git a/contracts/discovery/L1GNS.sol b/contracts/discovery/L1GNS.sol
@@ -107,7 +107,7 @@ contract L1GNS is GNS, L1GNSV1Storage {
             extraData
         );
 
-        subgraphData.reserveRatioDeprecated = 0;
+        subgraphData.__DEPRECATED_reserveRatio = 0;
         _burnNFT(_subgraphID);
         emit SubgraphSentToL2(_subgraphID, msg.sender, _l2Owner, tokensForL2);
     }
diff --git a/contracts/l2/discovery/L2GNS.sol b/contracts/l2/discovery/L2GNS.sol
@@ -244,7 +244,7 @@ contract L2GNS is GNS, L2GNSV1Storage, IL2GNS {
         SubgraphData storage subgraphData = _getSubgraphData(l2SubgraphID);
         IL2GNS.SubgraphL2TransferData storage transferData = subgraphL2TransferData[l2SubgraphID];
 
-        subgraphData.reserveRatioDeprecated = fixedReserveRatio;
+        subgraphData.__DEPRECATED_reserveRatio = fixedReserveRatio;
         // The subgraph will be disabled until finishSubgraphTransferFromL1 is called
         subgraphData.disabled = true;
 
diff --git a/contracts/rewards/RewardsManagerStorage.sol b/contracts/rewards/RewardsManagerStorage.sol
@@ -8,7 +8,7 @@ import "../governance/Managed.sol";
 contract RewardsManagerV1Storage is Managed {
     // -- State --
 
-    uint256 private issuanceRateDeprecated;
+    uint256 private __DEPRECATED_issuanceRate; // solhint-disable-line var-name-mixedcase
     uint256 public accRewardsPerSignal;
     uint256 public accRewardsPerSignalLastBlockUpdated;
 
@@ -29,7 +29,7 @@ contract RewardsManagerV2Storage is RewardsManagerV1Storage {
 
 contract RewardsManagerV3Storage is RewardsManagerV2Storage {
     // Snapshot of the total supply of GRT when accRewardsPerSignal was last updated
-    uint256 private tokenSupplySnapshotDeprecated;
+    uint256 private __DEPRECATED_tokenSupplySnapshot; // solhint-disable-line var-name-mixedcase
 }
 
 contract RewardsManagerV4Storage is RewardsManagerV3Storage {
diff --git a/contracts/staking/IStakingBase.sol b/contracts/staking/IStakingBase.sol
@@ -90,7 +90,7 @@ interface IStakingBase is IStakingData {
         address indexed indexer,
         uint32 indexingRewardCut,
         uint32 queryFeeCut,
-        uint32 cooldownBlocksDeprecated
+        uint32 __DEPRECATED_cooldownBlocks // solhint-disable-line var-name-mixedcase
     );
 
     /**
diff --git a/contracts/staking/IStakingData.sol b/contracts/staking/IStakingData.sol
@@ -18,7 +18,7 @@ interface IStakingData {
         uint256 createdAtEpoch; // Epoch when it was created
         uint256 closedAtEpoch; // Epoch when it was closed
         uint256 collectedFees; // Collected fees for the allocation
-        uint256 __DEPRECATED_effectiveAllocation; // Effective allocation when closed
+        uint256 __DEPRECATED_effectiveAllocation; // solhint-disable-line var-name-mixedcase
         uint256 accRewardsPerAllocatedToken; // Snapshot used for reward calc
         uint256 distributedRebates; // Collected rebates that have been rebated
     }
@@ -29,7 +29,7 @@ interface IStakingData {
      * @dev Delegation pool information. One per indexer.
      */
     struct DelegationPool {
-        uint32 cooldownBlocksDeprecated; // Blocks to wait before updating parameters (deprecated)
+        uint32 __DEPRECATED_cooldownBlocks; // solhint-disable-line var-name-mixedcase
         uint32 indexingRewardCut; // in PPM
         uint32 queryFeeCut; // in PPM
         uint256 updatedAtBlock; // Block when the pool was last updated
diff --git a/contracts/staking/IStakingExtension.sol b/contracts/staking/IStakingExtension.sol
@@ -20,7 +20,7 @@ interface IStakingExtension is IStakingData {
      * the original DelegationPool in IStakingData.sol contains a nested mapping.
      */
     struct DelegationPoolReturn {
-        uint32 cooldownBlocksDeprecated; // Blocks to wait before updating parameters (deprecated)
+        uint32 __DEPRECATED_cooldownBlocks; // solhint-disable-line var-name-mixedcase
         uint32 indexingRewardCut; // in PPM
         uint32 queryFeeCut; // in PPM
         uint256 updatedAtBlock; // Block when the pool was last updated
diff --git a/contracts/staking/StakingStorage.sol b/contracts/staking/StakingStorage.sol
@@ -32,7 +32,7 @@ contract StakingV1Storage is Managed {
     uint32 internal __protocolPercentage;
 
     /// @dev Period for allocation to be finalized
-    uint32 private __DEPRECATED_channelDisputeEpochs;
+    uint32 private __DEPRECATED_channelDisputeEpochs; // solhint-disable-line var-name-mixedcase
 
     /// @dev Maximum allocation time
     uint32 internal __maxAllocationEpochs;
@@ -55,7 +55,7 @@ contract StakingV1Storage is Managed {
     mapping(bytes32 => uint256) internal __subgraphAllocations;
 
     // Rebate pools : epoch => Pool
-    mapping(uint256 => uint256) private __DEPRECATED_rebates;
+    mapping(uint256 => uint256) private __DEPRECATED_rebates; // solhint-disable-line var-name-mixedcase
 
     // -- Slashing --
 
@@ -70,7 +70,7 @@ contract StakingV1Storage is Managed {
     uint32 internal __delegationRatio;
 
     /// @dev Time in blocks an indexer needs to wait to change delegation parameters (deprecated)
-    uint32 internal __DEPRECATED_delegationParametersCooldown;
+    uint32 internal __DEPRECATED_delegationParametersCooldown; // solhint-disable-line var-name-mixedcase
 
     /// @dev Time in epochs a delegator needs to wait to withdraw delegated stake
     uint32 internal __delegationUnbondingPeriod; // in epochs
diff --git a/test/l2/l2GNS.test.ts b/test/l2/l2GNS.test.ts
@@ -294,7 +294,7 @@ describe('L2GNS', () => {
       expect(subgraphData.vSignal).eq(0)
       expect(subgraphData.nSignal).eq(0)
       expect(subgraphData.subgraphDeploymentID).eq(HashZero)
-      expect(subgraphData.reserveRatioDeprecated).eq(DEFAULT_RESERVE_RATIO)
+      expect(subgraphData.__DEPRECATED_reserveRatio).eq(DEFAULT_RESERVE_RATIO)
       expect(subgraphData.disabled).eq(true)
       expect(subgraphData.withdrawableGRT).eq(0) // Important so that it's not the same as a deprecated subgraph!
 
@@ -334,7 +334,7 @@ describe('L2GNS', () => {
       expect(subgraphData.vSignal).eq(0)
       expect(subgraphData.nSignal).eq(0)
       expect(subgraphData.subgraphDeploymentID).eq(HashZero)
-      expect(subgraphData.reserveRatioDeprecated).eq(DEFAULT_RESERVE_RATIO)
+      expect(subgraphData.__DEPRECATED_reserveRatio).eq(DEFAULT_RESERVE_RATIO)
       expect(subgraphData.disabled).eq(true)
       expect(subgraphData.withdrawableGRT).eq(0) // Important so that it's not the same as a deprecated subgraph!
 
@@ -345,7 +345,7 @@ describe('L2GNS', () => {
       expect(l2SubgraphData.vSignal).eq(0)
       expect(l2SubgraphData.nSignal).eq(0)
       expect(l2SubgraphData.subgraphDeploymentID).eq(l2Subgraph.subgraphDeploymentID)
-      expect(l2SubgraphData.reserveRatioDeprecated).eq(DEFAULT_RESERVE_RATIO)
+      expect(l2SubgraphData.__DEPRECATED_reserveRatio).eq(DEFAULT_RESERVE_RATIO)
       expect(l2SubgraphData.disabled).eq(false)
       expect(l2SubgraphData.withdrawableGRT).eq(0)
     })
diff --git a/test/lib/gnsUtils.ts b/test/lib/gnsUtils.ts
@@ -20,7 +20,7 @@ export interface Subgraph {
   vSignal: BigNumber
   nSignal: BigNumber
   subgraphDeploymentID: string
-  reserveRatioDeprecated: number
+  __DEPRECATED_reserveRatio: number
   disabled: boolean
   withdrawableGRT: BigNumber
   id?: string
@@ -102,7 +102,7 @@ export const publishNewSubgraph = async (
   expect(subgraph.vSignal).eq(0)
   expect(subgraph.nSignal).eq(0)
   expect(subgraph.subgraphDeploymentID).eq(newSubgraph.subgraphDeploymentID)
-  expect(subgraph.reserveRatioDeprecated).eq(DEFAULT_RESERVE_RATIO)
+  expect(subgraph.__DEPRECATED_reserveRatio).eq(DEFAULT_RESERVE_RATIO)
   expect(subgraph.disabled).eq(false)
   expect(subgraph.withdrawableGRT).eq(0)
 
@@ -313,7 +313,7 @@ export const deprecateSubgraph = async (
   // Signal for the deployment must be all burned
   expect(afterSubgraph.vSignal.eq(toBN('0')))
   // Cleanup reserve ratio
-  expect(afterSubgraph.reserveRatioDeprecated).eq(0)
+  expect(afterSubgraph.__DEPRECATED_reserveRatio).eq(0)
   // Should be equal since owner pays curation tax
   expect(afterSubgraph.withdrawableGRT).eq(beforeTokens)
 

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ interface IGNS {`
`18`	`18`	`uint256 nSignal; // The token of the subgraph bonding curve`
`19`	`19`	`mapping(address => uint256) curatorNSignal;`
`20`	`20`	`bytes32 subgraphDeploymentID;`
`21`		`- uint32 reserveRatioDeprecated; // Ratio for the bonding curve, always 1 in PPM, deprecated.`
	`21`	`+ uint32 __DEPRECATED_reserveRatio; // solhint-disable-line var-name-mixedcase`
`22`	`22`	`bool disabled;`
`23`	`23`	`uint256 withdrawableGRT;`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,7 @@ contract L1GNS is GNS, L1GNSV1Storage {`
`107`	`107`	`extraData`
`108`	`108`	`);`
`109`	`109`
`110`		`- subgraphData.reserveRatioDeprecated = 0;`
	`110`	`+ subgraphData.__DEPRECATED_reserveRatio = 0;`
`111`	`111`	`_burnNFT(_subgraphID);`
`112`	`112`	`emit SubgraphSentToL2(_subgraphID, msg.sender, _l2Owner, tokensForL2);`
`113`	`113`	`}`