staking: remove channel public key from the allocate call and pass the allocationID. It was used to emit in the AllocationCreated event to allow for clients to route payments but now is deprecated.

abarmat · abarmat · commit d3576ceb2f3b · 2020-09-28T11:57:59.000-03:00
diff --git a/cli/commands/contracts/staking.ts b/cli/commands/contracts/staking.ts
@@ -33,7 +33,7 @@ export const withdraw = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<v
 export const allocate = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
   const subgraphDeploymentID = cliArgs.subgraphDeploymentID
   const amount = parseGRT(cliArgs.amount)
-  const channelPubKey = cliArgs.channelPubKey
+  const allocationID = cliArgs.allocationID
   const assetHolder = cliArgs.assetHolder
   const metadata = cliArgs.metadata
   const staking = cli.contracts.Staking
@@ -43,7 +43,7 @@ export const allocate = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<v
     cli.wallet,
     staking,
     'allocate',
-    ...[subgraphDeploymentID, amount, channelPubKey, assetHolder, metadata],
+    ...[subgraphDeploymentID, amount, allocationID, assetHolder, metadata],
   )
 }
 
@@ -184,8 +184,8 @@ export const stakingCommand = {
               requiresArg: true,
               demandOption: true,
             })
-            .option('channelPubKey', {
-              description: 'The public key used by the indexer to setup the off-chain channel',
+            .option('allocationID', {
+              description: 'Address used by the indexer as destination of funds of state channel',
               type: 'string',
               requiresArg: true,
               demandOption: true,
diff --git a/contracts/staking/IStaking.sol b/contracts/staking/IStaking.sol
@@ -117,7 +117,7 @@ interface IStaking {
     function allocate(
         bytes32 _subgraphDeploymentID,
         uint256 _tokens,
-        bytes calldata _channelPubKey,
+        address _allocationID,
         address _assetHolder,
         bytes32 _metadata
     ) external;
@@ -126,7 +126,7 @@ interface IStaking {
         address _indexer,
         bytes32 _subgraphDeploymentID,
         uint256 _tokens,
-        bytes calldata _channelPubKey,
+        address _allocationID,
         address _assetHolder,
         bytes32 _metadata
     ) external;
@@ -139,7 +139,7 @@ interface IStaking {
         address _indexer,
         bytes32 _subgraphDeploymentID,
         uint256 _tokens,
-        bytes calldata _channelPubKey,
+        address _allocationID,
         address _assetHolder,
         bytes32 _metadata
     ) external;
diff --git a/contracts/staking/Staking.sol b/contracts/staking/Staking.sol
@@ -93,7 +93,6 @@ contract Staking is StakingV1Storage, GraphUpgradeable, IStaking {
      * @dev Emitted when `indexer` allocated `tokens` amount to `subgraphDeploymentID`
      * during `epoch`.
      * `allocationID` indexer derived address used to identify the allocation.
-     * `channelPubKey` is the public key used for routing payments to the indexer channel.
      * `metadata` additional information related to the allocation.
      */
     event AllocationCreated(
@@ -102,7 +101,6 @@ contract Staking is StakingV1Storage, GraphUpgradeable, IStaking {
         uint256 epoch,
         uint256 tokens,
         address allocationID,
-        bytes channelPubKey,
         bytes32 metadata,
         address assetHolder
     );
@@ -684,22 +682,22 @@ contract Staking is StakingV1Storage, GraphUpgradeable, IStaking {
      * @dev Allocate available tokens to a subgraph deployment.
      * @param _subgraphDeploymentID ID of the SubgraphDeployment where tokens will be allocated
      * @param _tokens Amount of tokens to allocate
-     * @param _channelPubKey The public key used to route payments
+     * @param _allocationID The allocation identifier
      * @param _assetHolder Authorized sender address of collected funds
      * @param _metadata IPFS hash for additional information about the allocation
      */
     function allocate(
         bytes32 _subgraphDeploymentID,
         uint256 _tokens,
-        bytes calldata _channelPubKey,
+        address _allocationID,
         address _assetHolder,
         bytes32 _metadata
     ) external override notPaused {
         _allocate(
             msg.sender,
             _subgraphDeploymentID,
             _tokens,
-            _channelPubKey,
+            _allocationID,
             _assetHolder,
             _metadata
         );
@@ -710,26 +708,19 @@ contract Staking is StakingV1Storage, GraphUpgradeable, IStaking {
      * @param _indexer Indexer address to allocate funds from.
      * @param _subgraphDeploymentID ID of the SubgraphDeployment where tokens will be allocated
      * @param _tokens Amount of tokens to allocate
-     * @param _channelPubKey The public key used to route payments
+     * @param _allocationID The allocation identifier
      * @param _assetHolder Authorized sender address of collected funds
      * @param _metadata IPFS hash for additional information about the allocation
      */
     function allocateFrom(
         address _indexer,
         bytes32 _subgraphDeploymentID,
         uint256 _tokens,
-        bytes calldata _channelPubKey,
+        address _allocationID,
         address _assetHolder,
         bytes32 _metadata
     ) external override notPaused {
-        _allocate(
-            _indexer,
-            _subgraphDeploymentID,
-            _tokens,
-            _channelPubKey,
-            _assetHolder,
-            _metadata
-        );
+        _allocate(_indexer, _subgraphDeploymentID, _tokens, _allocationID, _assetHolder, _metadata);
     }
 
     /**
@@ -752,7 +743,7 @@ contract Staking is StakingV1Storage, GraphUpgradeable, IStaking {
      * @param _indexer Indexer address to allocate funds from.
      * @param _subgraphDeploymentID ID of the SubgraphDeployment where tokens will be allocated
      * @param _tokens Amount of tokens to allocate
-     * @param _channelPubKey The public key used to route payments
+     * @param _allocationID The allocation identifier
      * @param _assetHolder Authorized sender address of collected funds
      * @param _metadata IPFS hash for additional information about the allocation
      */
@@ -762,19 +753,12 @@ contract Staking is StakingV1Storage, GraphUpgradeable, IStaking {
         address _indexer,
         bytes32 _subgraphDeploymentID,
         uint256 _tokens,
-        bytes calldata _channelPubKey,
+        address _allocationID,
         address _assetHolder,
         bytes32 _metadata
     ) external override notPaused {
         _closeAllocation(_closingAllocationID, _poi);
-        _allocate(
-            _indexer,
-            _subgraphDeploymentID,
-            _tokens,
-            _channelPubKey,
-            _assetHolder,
-            _metadata
-        );
+        _allocate(_indexer, _subgraphDeploymentID, _tokens, _allocationID, _assetHolder, _metadata);
     }
 
     /**
@@ -901,15 +885,15 @@ contract Staking is StakingV1Storage, GraphUpgradeable, IStaking {
      * @param _indexer Indexer address to allocate funds from.
      * @param _subgraphDeploymentID ID of the SubgraphDeployment where tokens will be allocated
      * @param _tokens Amount of tokens to allocate
-     * @param _channelPubKey The public key used by the indexer to setup the off-chain channel
+     * @param _allocationID The allocationID will work to identify collected funds related to this allocation
      * @param _assetHolder Authorized sender address of collected funds
      * @param _metadata Metadata related to the allocation
      */
     function _allocate(
         address _indexer,
         bytes32 _subgraphDeploymentID,
         uint256 _tokens,
-        bytes memory _channelPubKey,
+        address _allocationID,
         address _assetHolder,
         bytes32 _metadata
     ) internal {
@@ -920,23 +904,15 @@ contract Staking is StakingV1Storage, GraphUpgradeable, IStaking {
         // Only allocations with a non-zero token amount are allowed
         require(_tokens > 0, "Cannot allocate zero tokens");
 
-        // Channel public key must be in uncompressed format
-        require(
-            uint8(_channelPubKey[0]) == 4 && _channelPubKey.length == 65,
-            "Invalid channel public key"
-        );
+        // Check allocation ID
+        require(_allocationID != address(0), "Invalid allocationID");
 
         // Needs to have free capacity not used for other purposes to allocate
         require(getIndexerCapacity(_indexer) >= _tokens, "Not enough tokens available to allocate");
 
-        // A channel public key is derived by the indexer when creating the offchain payment channel.
-        // Get the Ethereum address from the public key and use as allocation identifier.
-        // The allocationID will work to identify collected funds related to this allocation.
-        address allocationID = address(uint256(keccak256(_sliceByte(bytes(_channelPubKey)))));
-
         // Cannot reuse an allocationID that has already been used in an allocation
         require(
-            _getAllocationState(allocationID) == AllocationState.Null,
+            _getAllocationState(_allocationID) == AllocationState.Null,
             "AllocationID already used"
         );
 
@@ -954,7 +930,7 @@ contract Staking is StakingV1Storage, GraphUpgradeable, IStaking {
             _assetHolder, // Source address for allocation collected funds
             _updateRewards(_subgraphDeploymentID) // Initialize accumulated rewards per stake allocated
         );
-        allocations[allocationID] = alloc;
+        allocations[_allocationID] = alloc;
 
         // Mark allocated tokens as used
         indexerStake.allocate(alloc.tokens);
@@ -970,8 +946,7 @@ contract Staking is StakingV1Storage, GraphUpgradeable, IStaking {
             _subgraphDeploymentID,
             alloc.createdAtEpoch,
             alloc.tokens,
-            allocationID,
-            _channelPubKey,
+            _allocationID,
             _metadata,
             _assetHolder
         );
@@ -1309,38 +1284,6 @@ contract Staking is StakingV1Storage, GraphUpgradeable, IStaking {
         return _tokens.mul((shouldCap) ? maxAllocationEpochs : _numEpochs);
     }
 
-    /**
-     * @dev Removes the first byte from a bytes array.
-     * @param _bytes Byte array to slice
-     * @return New bytes array
-     */
-    function _sliceByte(bytes memory _bytes) internal pure returns (bytes memory) {
-        bytes memory tempBytes;
-        uint256 length = _bytes.length - 1;
-
-        assembly {
-            tempBytes := mload(0x40)
-
-            let lengthmod := and(length, 31)
-            let mc := add(add(tempBytes, lengthmod), mul(0x20, iszero(lengthmod)))
-            let end := add(mc, length)
-
-            for {
-                let cc := add(add(add(_bytes, lengthmod), mul(0x20, iszero(lengthmod))), 1)
-            } lt(mc, end) {
-                mc := add(mc, 0x20)
-                cc := add(cc, 0x20)
-            } {
-                mstore(mc, mload(cc))
-            }
-
-            mstore(tempBytes, length)
-            mstore(0x40, and(add(mc, 31), not(31)))
-        }
-
-        return tempBytes;
-    }
-
     /**
      * @dev Triggers an update of rewards due to a change in allocations.
      * @param _subgraphDeploymentID Subgrapy deployment updated
diff --git a/test/disputes/poi.test.ts b/test/disputes/poi.test.ts
@@ -53,11 +53,11 @@ describe('DisputeManager:POI', async () => {
     // Dispute manager is allowed to slash
     await staking.connect(governor.signer).setSlasher(disputeManager.address, true)
 
-    // Stake
-    const indexerList = [{ wallet: indexer, pubKey: indexerChannelKey.pubKey }]
+    // Stake & allocate
+    const indexerList = [{ wallet: indexer, allocationID: indexerChannelKey.address }]
     for (const activeIndexer of indexerList) {
       const indexerWallet = activeIndexer.wallet
-      const indexerPubKey = activeIndexer.pubKey
+      const indexerAllocationID = activeIndexer.allocationID
 
       // Give some funds to the indexer
       await grt.connect(governor.signer).mint(indexerWallet.address, indexerTokens)
@@ -70,7 +70,7 @@ describe('DisputeManager:POI', async () => {
         .allocate(
           subgraphDeploymentID,
           indexerAllocatedTokens,
-          indexerPubKey,
+          indexerAllocationID,
           assetHolder.address,
           metadata,
         )
@@ -144,7 +144,7 @@ describe('DisputeManager:POI', async () => {
         .allocate(
           subgraphDeploymentID,
           indexerAllocatedTokens,
-          indexerChannelKey.pubKey,
+          allocationID,
           assetHolder.address,
           metadata,
         )
diff --git a/test/disputes/query.test.ts b/test/disputes/query.test.ts
@@ -114,12 +114,12 @@ describe('DisputeManager:Query', async () => {
 
     // Stake
     const indexerList = [
-      { wallet: indexer, pubKey: indexer1ChannelKey.pubKey },
-      { wallet: indexer2, pubKey: indexer2ChannelKey.pubKey },
+      { wallet: indexer, allocationID: indexer1ChannelKey.address },
+      { wallet: indexer2, allocationID: indexer2ChannelKey.address },
     ]
     for (const activeIndexer of indexerList) {
       const indexerWallet = activeIndexer.wallet
-      const indexerPubKey = activeIndexer.pubKey
+      const indexerAllocationID = activeIndexer.allocationID
 
       // Give some funds to the indexer
       await grt.connect(governor.signer).mint(indexerWallet.address, indexerTokens)
@@ -132,7 +132,7 @@ describe('DisputeManager:Query', async () => {
         .allocate(
           dispute.receipt.subgraphDeploymentID,
           indexerAllocatedTokens,
-          indexerPubKey,
+          indexerAllocationID,
           assetHolder.address,
           metadata,
         )
@@ -216,7 +216,7 @@ describe('DisputeManager:Query', async () => {
         .allocate(
           dispute.receipt.subgraphDeploymentID,
           indexerAllocatedTokens,
-          indexer1ChannelKey.pubKey,
+          indexer1ChannelKey.address,
           assetHolder.address,
           metadata,
         )
@@ -433,11 +433,11 @@ describe('DisputeManager:Query', async () => {
               .withArgs(dispute.id, dispute.indexerAddress, fisherman.address, fishermanDeposit)
 
             // After state
-            const afterTishermanBalance = await grt.balanceOf(fisherman.address)
+            const afterFishermanBalance = await grt.balanceOf(fisherman.address)
             const afterTotalSupply = await grt.totalSupply()
 
             // No change in fisherman balance
-            expect(afterTishermanBalance).eq(beforeFishermanBalance)
+            expect(afterFishermanBalance).eq(beforeFishermanBalance)
             // Burn fisherman deposit
             const burnedTokens = fishermanDeposit
             expect(afterTotalSupply).eq(beforeTotalSupply.sub(burnedTokens))
diff --git a/test/rewards/rewards.test.ts b/test/rewards/rewards.test.ts
@@ -49,8 +49,6 @@ describe('Rewards', () => {
   const subgraphDeploymentID1 = randomHexBytes()
   const subgraphDeploymentID2 = randomHexBytes()
   const allocationID = '0x6367E9dD7641e0fF221740b57B8C730031d72530'
-  const channelPubKey =
-    '0x0456708870bfd5d8fc956fe33285dcf59b075cd7a25a21ee00834e480d3754bcda180e670145a290bb4bebca8e105ea7776a7b39e16c4df7d4d1083260c6f05d53'
   const metadata = HashZero
 
   const ISSUANCE_RATE_PERIODS = 4 // blocks required to issue 5% rewards
@@ -380,7 +378,7 @@ describe('Rewards', () => {
         .allocate(
           subgraphDeploymentID1,
           tokensToAllocate,
-          channelPubKey,
+          allocationID,
           assetHolder.address,
           metadata,
         )
@@ -417,7 +415,7 @@ describe('Rewards', () => {
         .allocate(
           subgraphDeploymentID1,
           tokensToAllocate,
-          channelPubKey,
+          allocationID,
           assetHolder.address,
           metadata,
         )
@@ -460,7 +458,7 @@ describe('Rewards', () => {
         .allocate(
           subgraphDeploymentID1,
           tokensToAllocate,
-          channelPubKey,
+          allocationID,
           assetHolder.address,
           metadata,
         )
@@ -524,7 +522,7 @@ describe('Rewards', () => {
         .allocate(
           subgraphDeploymentID1,
           tokensToAllocate,
-          channelPubKey,
+          allocationID,
           assetHolder.address,
           metadata,
         )
diff --git a/test/staking/allocation.test.ts b/test/staking/allocation.test.ts
diff --git a/test/staking/delegation.test.ts b/test/staking/delegation.test.ts
diff --git a/test/staking/staking.test.ts b/test/staking/staking.test.ts
