delegation: v1 (#216)

* delegation: interface v1
* staking: restore commented out tests
* refactor: use factory for deployment
* delegation: add tests and shares calculation
* delegation: add distribution of fees to delegators
* delegation: support delegation capacity when allocating
* delegation: move delegation fee to claim
* delegation: add redelegate function

Author: abarmat

contracts/Staking.sol

@@ -3,7 +3,6 @@ pragma experimental ABIEncoderV2;
 
 import "@openzeppelin/contracts/math/SafeMath.sol";
 
-
 /**
  * @title A collection of data structures and functions to manage the Stake state
  *        Used for low-level state changes, require() conditions should be evaluated
@@ -20,16 +19,16 @@ library Stakes {
     }
 
     struct Indexer {
-        uint256 tokensIndexer; // Tokens on the indexer stake (staked by the indexer)
-        uint256 tokensAllocated; // Tokens used in SubgraphDeployment allocations
+        uint256 tokensStaked; // Tokens on the indexer stake (staked by the indexer)
+        uint256 tokensAllocated; // Tokens used in allocations
         uint256 tokensLocked; // Tokens locked for withdrawal subject to thawing period
         uint256 tokensLockedUntil; // Time when locked tokens can be withdrawn
         // SubgraphDeployment stake allocation tracking : subgraphDeploymentID => Allocation
         mapping(bytes32 => Allocation) allocations;
     }
 
     /**
-     * @dev Allocate tokens from the available stack to a SubgraphDeployment
+     * @dev Allocate tokens from the main stack to a SubgraphDeployment.
      * @param stake Stake data
      * @param _subgraphDeploymentID SubgraphDeployment where to allocate tokens
      * @param _tokens Amount of tokens to allocate
@@ -46,7 +45,7 @@ library Stakes {
     }
 
     /**
-     * @dev Unallocate tokens from a SubgraphDeployment
+     * @dev Unallocate tokens from a SubgraphDeployment.
      * @param stake Stake data
      * @param _subgraphDeploymentID SubgraphDeployment from where to unallocate tokens
      * @param _tokens Amount of tokens to unallocate
@@ -63,25 +62,25 @@ library Stakes {
     }
 
     /**
-     * @dev Deposit tokens to the indexer stake
+     * @dev Deposit tokens to the indexer stake.
      * @param stake Stake data
      * @param _tokens Amount of tokens to deposit
      */
     function deposit(Stakes.Indexer storage stake, uint256 _tokens) internal {
-        stake.tokensIndexer = stake.tokensIndexer.add(_tokens);
+        stake.tokensStaked = stake.tokensStaked.add(_tokens);
     }
 
     /**
-     * @dev Release tokens from the indexer stake
+     * @dev Release tokens from the indexer stake.
      * @param stake Stake data
      * @param _tokens Amount of tokens to release
      */
     function release(Stakes.Indexer storage stake, uint256 _tokens) internal {
-        stake.tokensIndexer = stake.tokensIndexer.sub(_tokens);
+        stake.tokensStaked = stake.tokensStaked.sub(_tokens);
     }
 
     /**
-     * @dev Lock tokens until a thawing period expires
+     * @dev Lock tokens until a thawing period expires,
      * @param stake Stake data
      * @param _tokens Amount of tokens to unstake
      * @param _thawingPeriod Period in blocks that need to pass before withdrawal
@@ -103,7 +102,7 @@ library Stakes {
     }
 
     /**
-     * @dev Unlock tokens
+     * @dev Unlock tokens.
      * @param stake Stake data
      * @param _tokens Amount of tokens to unkock
      */
@@ -115,7 +114,7 @@ library Stakes {
     }
 
     /**
-     * @dev Take all tokens out from the locked stack for withdrawal
+     * @dev Take all tokens out from the locked stack for withdrawal.
      * @param stake Stake data
      * @return Amount of tokens being withdrawn
      */
@@ -135,14 +134,15 @@ library Stakes {
     }
 
     /**
-     * @dev Get the locking period of the tokens to unstake, if already unstaked before calculate the weighted average
+     * @dev Get the locking period of the tokens to unstake.
+     * If already unstaked before calculate the weighted average.
      * @param stake Stake data
      * @param _tokens Amount of tokens to unstake
      * @param _thawingPeriod Period in blocks that need to pass before withdrawal
      * @return True if staked
      */
     function getLockingPeriod(
-        Stakes.Indexer storage stake,
+        Stakes.Indexer memory stake,
         uint256 _tokens,
         uint256 _thawingPeriod
     ) internal view returns (uint256) {
@@ -157,16 +157,16 @@ library Stakes {
     }
 
     /**
-     * @dev Return true if there are tokens staked by the Indexer
+     * @dev Return true if there are tokens staked by the Indexer.
      * @param stake Stake data
      * @return True if staked
      */
-    function hasTokens(Stakes.Indexer storage stake) internal view returns (bool) {
-        return stake.tokensIndexer > 0;
+    function hasTokens(Stakes.Indexer memory stake) internal view returns (bool) {
+        return stake.tokensStaked > 0;
     }
 
     /**
-     * @dev Return true if the indexer has allocated stake on the SubgraphDeployment
+     * @dev Return true if the indexer has allocated stake on the SubgraphDeployment.
      * @param stake Stake data
      * @param _subgraphDeploymentID SubgraphDeployment for the allocation
      * @return True if allocated
@@ -180,77 +180,67 @@ library Stakes {
     }
 
     /**
-     * @dev Total tokens staked from indexer
+     * @dev Return the amount of tokens used in allocations and locked for withdrawal.
      * @param stake Stake data
      * @return Token amount
      */
-    function tokensStaked(Stakes.Indexer storage stake) internal view returns (uint256) {
-        return stake.tokensIndexer;
+    function tokensUsed(Stakes.Indexer memory stake) internal view returns (uint256) {
+        return stake.tokensAllocated.add(stake.tokensLocked);
     }
 
     /**
-     * @dev Tokens available for use in allocations
-     * @dev tokensIndexer - tokensAllocated - tokensLocked
+     * @dev Tokens free balance on the indexer stake.
+     * tokensStaked - tokensAllocated - tokensLocked
      * @param stake Stake data
      * @return Token amount
      */
-    function tokensAvailable(Stakes.Indexer storage stake) internal view returns (uint256) {
-        uint256 _tokensStaked = stake.tokensStaked();
-        uint256 tokensUsed = stake.tokensAllocated.add(stake.tokensLocked);
-        // Stake is over allocated: return 0 to avoid stake to be used until the overallocation
-        // is restored by staking more tokens or unallocating tokens
-        if (tokensUsed > _tokensStaked) {
+    function tokensAvailable(Stakes.Indexer memory stake) internal view returns (uint256) {
+        uint256 tokensUsed = stake.tokensUsed();
+        // Indexer stake is over allocated: return 0 to avoid stake to be used until
+        // the overallocation is restored by staking more tokens or unallocating tokens
+        if (tokensUsed > stake.tokensStaked) {
             return 0;
         }
-        return _tokensStaked.sub(tokensUsed);
-    }
-
-    /**
-     * @dev Tokens used for slashing whenever necessary
-     * @param stake Stake data
-     * @return Token amount
-     */
-    function tokensSlashable(Stakes.Indexer storage stake) internal view returns (uint256) {
-        return stake.tokensIndexer;
+        return stake.tokensStaked.sub(tokensUsed);
     }
 
     /**
-     * @dev Tokens available for withdrawal after thawing period
+     * @dev Tokens available for withdrawal after thawing period.
      * @param stake Stake data
      * @return Token amount
      */
-    function tokensWithdrawable(Stakes.Indexer storage stake) internal view returns (uint256) {
+    function tokensWithdrawable(Stakes.Indexer memory stake) internal view returns (uint256) {
         // No tokens to withdraw before locking period
         if (stake.tokensLockedUntil == 0 || block.number < stake.tokensLockedUntil) {
             return 0;
         }
         // Cannot withdraw more than currently staked
         // This condition can happen if while tokens are locked for withdrawal a slash condition happens
         // In that case the total staked tokens could be below the amount to be withdrawn
-        if (stake.tokensLocked > stake.tokensIndexer) {
-            return stake.tokensIndexer;
+        if (stake.tokensLocked > stake.tokensStaked) {
+            return stake.tokensStaked;
         }
         return stake.tokensLocked;
     }
 
     /**
-     * @dev Return if channel for an allocation is active
+     * @dev Return if channel for an allocation is active.
      * @param alloc Allocation data
      * @return True if channel related to allocation is active
      */
-    function hasChannel(Stakes.Allocation storage alloc) internal view returns (bool) {
+    function hasChannel(Stakes.Allocation memory alloc) internal view returns (bool) {
         return alloc.channelID != address(0);
     }
 
     /**
-     * @dev Get the effective stake allocation considering epochs from allocation to settlement
+     * @dev Get the effective stake allocation considering epochs from allocation to settlement.
      * @param alloc Allocation data
      * @param _numEpochs Number of epochs that passed from allocation to settlement
      * @param _maxEpochs Number of epochs used as a maximum to cap effective allocation
      * @return Effective allocated tokens accross epochs
      */
     function getTokensEffectiveAllocation(
-        Stakes.Allocation storage alloc,
+        Stakes.Allocation memory alloc,
         uint256 _numEpochs,
         uint256 _maxEpochs
     ) internal view returns (uint256) {

contracts/libs/Stakes.sol

@@ -5,7 +5,7 @@ import { bigNumberify, parseEther, BigNumberish, BigNumber } from 'ethers/utils'
 import { ChallengeStatus, MinimalTransaction } from '@connext/types'
 import { ChannelSigner, toBN, stringify } from '@connext/utils'
 
-import { deployGRTWithFactory, deployMultisigWithProxy } from '../lib/deployment'
+import { deployGRT, deployMultisigWithProxy } from '../lib/deployment'
 import {
   getRandomFundedChannelSigners,
   fundMultisig,
@@ -61,7 +61,7 @@ describe('Indexer Channel Operations', () => {
     governer = accounts[0]
 
     // Deploy graph token
-    token = await deployGRTWithFactory(await governer.getAddress())
+    token = await deployGRT(await governer.getAddress())
 
     // Get channel signers
     const [_node, _indexer, _thirdparty] = await getRandomFundedChannelSigners(3, governer, token)

package-lock.json

@@ -5,7 +5,7 @@ import { Signer } from 'ethers'
 import { parseEther } from 'ethers/utils'
 
 import { GraphToken } from '../../build/typechain/contracts/GraphToken'
-import { deployMultisigWithProxy, deployGRTWithFactory } from '../lib/deployment'
+import { deployMultisigWithProxy, deployGRT } from '../lib/deployment'
 import { getRandomFundedChannelSigners } from '../lib/channel'
 import { MinimumViableMultisig } from '../../build/typechain/contracts/MinimumViableMultisig'
 import { IndexerCtdt } from '../../build/typechain/contracts/IndexerCtdt'
@@ -32,7 +32,7 @@ describe('MinimumViableMultisig.sol', () => {
     governor = accounts[0]
 
     // Deploy graph token
-    token = await deployGRTWithFactory(await governor.getAddress())
+    token = await deployGRT(await governor.getAddress())
 
     // Get channel signers
     const [_node, _indexer] = await getRandomFundedChannelSigners(2, governor, token)

test/connext/general.test.ts

@@ -20,10 +20,10 @@ describe('Curation', () => {
 
   beforeEach(async function() {
     // Deploy graph token
-    grt = await deployment.deployGRT(governor.address, me)
+    grt = await deployment.deployGRT(governor.address)
 
     // Deploy curation contract
-    curation = await deployment.deployCuration(governor.address, grt.address, me)
+    curation = await deployment.deployCuration(governor.address, grt.address)
     await curation.connect(governor).setStaking(staking.address)
   })
 

test/connext/multisig.test.ts

@@ -105,18 +105,17 @@ describe('Disputes', async () => {
 
   beforeEach(async function() {
     // Deploy epoch contract
-    epochManager = await deployment.deployEpochManager(governor.address, me)
+    epochManager = await deployment.deployEpochManager(governor.address)
 
     // Deploy graph token
-    grt = await deployment.deployGRT(governor.address, me)
+    grt = await deployment.deployGRT(governor.address)
 
     // Deploy staking contract
     staking = await deployment.deployStaking(
       governor,
       grt.address,
       epochManager.address,
       AddressZero,
-      me,
     )
 
     // Deploy dispute contract
@@ -125,7 +124,6 @@ describe('Disputes', async () => {
       grt.address,
       arbitrator.address,
       staking.address,
-      me,
     )
 
     // Create an attestation
@@ -146,7 +144,7 @@ describe('Disputes', async () => {
     }
   })
 
-  describe('state variables functions', () => {
+  describe('configuration', () => {
     it('should set `governor`', async function() {
       // Set right in the constructor
       expect(await disputeManager.governor()).to.eq(governor.address)

test/curation.test.ts

@@ -22,10 +22,10 @@ describe('EpochManager', () => {
 
   beforeEach(async function() {
     // Deploy epoch manager contract
-    epochManager = await deployment.deployEpochManager(governor.address, me)
+    epochManager = await deployment.deployEpochManager(governor.address)
   })
 
-  describe('state variables functions', () => {
+  describe('configuration', () => {
     it('should set `governor`', async function() {
       // Set right in the constructor
       expect(await epochManager.governor()).to.eq(governor.address)