Merge remote-tracking branch 'origin/dev' into ariel/zero-alloc

abarmat · abarmat · commit 064d362af559 · 2022-05-09T01:13:55.000-03:00
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
-![License: GPL](https://img.shields.io/badge/license-GPL-blue)
-![Version Badge](https://img.shields.io/badge/version-1.6.0-lightgrey.svg)
+![License: GPL](https://img.shields.io/badge/license-GPLv2-blue)
+![Version Badge](https://img.shields.io/badge/version-1.11.0-lightgrey.svg)
 ![CI Status](https://github.com/graphprotocol/contracts/actions/workflows/npmtest.yml/badge.svg)
 [![codecov](https://codecov.io/gh/graphprotocol/contracts/branch/dev/graph/badge.svg?token=S8JWGR9SBN)](https://codecov.io/gh/graphprotocol/contracts)
 
diff --git a/addresses.json b/addresses.json
diff --git a/audits/ConsenSysDiligence/2021-08-staking-multicall-and-delegation-fixes.pdf b/audits/ConsenSysDiligence/2021-08-staking-multicall-and-delegation-fixes.pdf
diff --git a/cli/commands/contracts/staking.ts b/cli/commands/contracts/staking.ts
@@ -36,7 +36,8 @@ export const allocate = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<v
   const staking = cli.contracts.Staking
 
   logger.info(`Allocating ${cliArgs.amount} tokens on ${subgraphDeploymentID}...`)
-  await sendTransaction(cli.wallet, staking, 'allocate', [
+  await sendTransaction(cli.wallet, staking, 'allocateFrom', [
+    cli.walletAddress,
     subgraphDeploymentID,
     amount,
     allocationID,
diff --git a/contracts/staking/Staking.sol b/contracts/staking/Staking.sol
@@ -5,6 +5,7 @@ pragma abicoder v2;
 
 import "@openzeppelin/contracts/cryptography/ECDSA.sol";
 
+import "../base/Multicall.sol";
 import "../upgrades/GraphUpgradeable.sol";
 import "../utils/TokenUtils.sol";
 
@@ -20,7 +21,7 @@ import "./libs/Stakes.sol";
  * Allocations on a Subgraph. It also allows Delegators to Delegate towards an Indexer. The
  * contract also has the slashing functionality.
  */
-contract Staking is StakingV2Storage, GraphUpgradeable, IStaking {
+contract Staking is StakingV2Storage, GraphUpgradeable, IStaking, Multicall {
     using SafeMath for uint256;
     using Stakes for Stakes.Indexer;
     using Rebates for Rebates.Pool;
diff --git a/hardhat.config.ts b/hardhat.config.ts
@@ -125,7 +125,7 @@ const config: HardhatUserConfig = {
         mnemonic: DEFAULT_TEST_MNEMONIC,
       },
       mining: {
-        auto: true,
+        auto: false,
         interval: 30000,
       },
       hardfork: 'london',
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/contracts",
-  "version": "1.10.1",
+  "version": "1.11.1",
   "description": "Contracts for the Graph Protocol",
   "directories": {
     "test": "test"
@@ -103,7 +103,7 @@
     "lint": "yarn lint:ts && yarn lint:sol",
     "lint:fix": "yarn lint:ts:fix && yarn lint:sol:fix",
     "lint:ts": "eslint '*/**/*.{js,ts}'",
-    "lint:ts:fix": "prettier:ts && eslint '*/**/*.{js,ts}' --fix",
+    "lint:ts:fix": "yarn prettier:ts && eslint '*/**/*.{js,ts}' --fix",
     "lint:sol": "solhint './contracts/**/*.sol'",
     "lint:sol:fix": "yarn prettier:sol && solhint --fix './contracts/**/*.sol'",
     "prettier": "yarn prettier:ts && yarn prettier:sol",
@@ -134,8 +134,8 @@
     "type": "git",
     "url": "git+https://github.com/graphprotocol/contracts.git"
   },
-  "author": "TheGraph Team",
-  "license": "MIT",
+  "author": "The Graph Team",
+  "license": "GPL-2.0-or-later",
   "bugs": {
     "url": "https://github.com/graphprotocol/contracts/issues"
   },
diff --git a/scripts/test b/scripts/test
@@ -41,7 +41,7 @@ fi
 mkdir -p reports
 
 # Run using the standalone evm instance
-npx hardhat test --network hardhat
+npx hardhat test --network hardhat $@
 
 ### Cleanup
 
diff --git a/tasks/contracts/functions.ts b/tasks/contracts/functions.ts
@@ -20,6 +20,14 @@ task('contracts:functions', 'Print function hashes for contracts')
         console.log(fnSig, '->', hre.ethers.utils.id(fnSig).slice(0, 10))
       }
     }
+
+    console.log('## GNS ##')
+    for (const fn of Object.entries(env.contracts.GNS.functions)) {
+      const [fnSig] = fn
+      if (fnSig.indexOf('(') != -1) {
+        console.log(fnSig, '->', hre.ethers.utils.id(fnSig).slice(0, 10))
+      }
+    }
   })
 
 task('contracts:layout', 'Display storage layout').setAction(async (_, hre) => {
diff --git a/test/disputes/poi.test.ts b/test/disputes/poi.test.ts
@@ -79,7 +79,8 @@ describe('DisputeManager:POI', async () => {
       await staking.connect(indexerAccount.signer).stake(indexerTokens)
       await staking
         .connect(indexerAccount.signer)
-        .allocate(
+        .allocateFrom(
+          indexerAccount.address,
           subgraphDeploymentID,
           indexerAllocatedTokens,
           allocationID,
@@ -147,7 +148,8 @@ describe('DisputeManager:POI', async () => {
       await staking.connect(indexer.signer).stake(indexerTokens)
       const tx1 = await staking
         .connect(indexer.signer)
-        .allocate(
+        .allocateFrom(
+          indexer.address,
           subgraphDeploymentID,
           indexerAllocatedTokens,
           allocationID,
diff --git a/test/disputes/query.test.ts b/test/disputes/query.test.ts
@@ -113,7 +113,8 @@ describe('DisputeManager:Query', async () => {
       await staking.connect(indexerAccount.signer).stake(indexerTokens)
       await staking
         .connect(indexerAccount.signer)
-        .allocate(
+        .allocateFrom(
+          indexerAccount.address,
           dispute.receipt.subgraphDeploymentID,
           indexerAllocatedTokens,
           allocationID,
@@ -194,7 +195,8 @@ describe('DisputeManager:Query', async () => {
       await staking.connect(indexer.signer).stake(indexerTokens)
       const tx1 = await staking
         .connect(indexer.signer)
-        .allocate(
+        .allocateFrom(
+          indexer.address,
           dispute.receipt.subgraphDeploymentID,
           indexerAllocatedTokens,
           indexer1ChannelKey.address,
diff --git a/test/lib/fixtures.ts b/test/lib/fixtures.ts
@@ -2,7 +2,7 @@
 import { utils, Wallet, Signer } from 'ethers'
 
 import * as deployment from './deployment'
-import { evmSnapshot, evmRevert } from './testHelpers'
+import { evmSnapshot, evmRevert, provider } from './testHelpers'
 
 export class NetworkFixture {
   lastSnapshotId: number
@@ -16,6 +16,12 @@ export class NetworkFixture {
     slasher: Signer = Wallet.createRandom() as Signer,
     arbitrator: Signer = Wallet.createRandom() as Signer,
   ): Promise<any> {
+    // Enable automining with each transaction, and disable
+    // the mining interval. Individual tests may modify this
+    // behavior as needed.
+    provider().send('evm_setIntervalMining', [0])
+    provider().send('evm_setAutomine', [true])
+
     // Roles
     const arbitratorAddress = await arbitrator.getAddress()
     const slasherAddress = await slasher.getAddress()
diff --git a/test/lib/testHelpers.ts b/test/lib/testHelpers.ts
@@ -74,14 +74,13 @@ export const advanceBlocks = async (blocks: string | number | BigNumber): Promis
   const steps = typeof blocks === 'number' || typeof blocks === 'string' ? toBN(blocks) : blocks
   const currentBlock = await latestBlock()
   const toBlock = currentBlock.add(steps)
-  await advanceBlockTo(toBlock)
+  return advanceBlockTo(toBlock)
 }
 
 export const advanceToNextEpoch = async (epochManager: EpochManager): Promise<void> => {
-  const currentBlock = await latestBlock()
-  const epochLength = await epochManager.epochLength()
-  const nextEpochBlock = currentBlock.add(epochLength)
-  await advanceBlockTo(nextEpochBlock)
+  const blocksSinceEpoch = await epochManager.currentEpochBlockSinceStart()
+  const epochLen = await epochManager.epochLength()
+  return advanceBlocks(epochLen.sub(blocksSinceEpoch))
 }
 
 export const advanceEpochs = async (epochManager: EpochManager, n: number): Promise<void> => {
diff --git a/test/payments/allocationExchange.test.ts b/test/payments/allocationExchange.test.ts
@@ -102,7 +102,8 @@ describe('AllocationExchange', () => {
     await staking.connect(indexer.signer).stake(stakeTokens)
     await staking
       .connect(indexer.signer)
-      .allocate(
+      .allocateFrom(
+        indexer.address,
         subgraphDeploymentID,
         stakeTokens,
         allocationID,
diff --git a/test/payments/withdrawHelper.test.ts b/test/payments/withdrawHelper.test.ts
@@ -86,7 +86,8 @@ describe('WithdrawHelper', () => {
       await staking.connect(indexer.signer).stake(stakeTokens)
       await staking
         .connect(indexer.signer)
-        .allocate(
+        .allocateFrom(
+          indexer.address,
           subgraphDeploymentID,
           stakeTokens,
           allocationID,
diff --git a/test/rewards/rewards.test.ts b/test/rewards/rewards.test.ts
@@ -391,7 +391,8 @@ describe('Rewards', () => {
         await staking.connect(indexer1.signer).stake(tokensToAllocate)
         await staking
           .connect(indexer1.signer)
-          .allocate(
+          .allocateFrom(
+            indexer1.address,
             subgraphDeploymentID1,
             tokensToAllocate,
             allocationID,
@@ -428,7 +429,8 @@ describe('Rewards', () => {
         await staking.connect(indexer1.signer).stake(tokensToAllocate)
         await staking
           .connect(indexer1.signer)
-          .allocate(
+          .allocateFrom(
+            indexer1.address,
             subgraphDeploymentID1,
             tokensToAllocate,
             allocationID,
@@ -471,7 +473,8 @@ describe('Rewards', () => {
         await staking.connect(indexer1.signer).stake(tokensToAllocate)
         await staking
           .connect(indexer1.signer)
-          .allocate(
+          .allocateFrom(
+            indexer1.address,
             subgraphDeploymentID1,
             tokensToAllocate,
             allocationID,
@@ -516,7 +519,8 @@ describe('Rewards', () => {
         await staking.connect(indexer1.signer).stake(tokensToAllocate)
         await staking
           .connect(indexer1.signer)
-          .allocate(
+          .allocateFrom(
+            indexer1.address,
             subgraphDeploymentID1,
             tokensToAllocate,
             allocationID,
@@ -558,7 +562,8 @@ describe('Rewards', () => {
         // Allocate
         await staking
           .connect(indexer1.signer)
-          .allocate(
+          .allocateFrom(
+            indexer1.address,
             subgraphDeploymentID1,
             tokensToAllocate,
             allocationID,
@@ -568,19 +573,28 @@ describe('Rewards', () => {
       }
 
       it('should distribute rewards on closed allocation and stake', async function () {
+        // Align with the epoch boundary
+        await advanceToNextEpoch(epochManager)
         // Setup
         await setupIndexerAllocation()
 
         // Jump
-        await advanceBlocks(await epochManager.epochLength())
+        await advanceToNextEpoch(epochManager)
 
         // Before state
         const beforeTokenSupply = await grt.totalSupply()
         const beforeIndexer1Stake = await staking.getIndexerStakedTokens(indexer1.address)
         const beforeIndexer1Balance = await grt.balanceOf(indexer1.address)
         const beforeStakingBalance = await grt.balanceOf(staking.address)
 
-        const expectedIndexingRewards = toGRT('1471954234')
+        // All the rewards in this subgraph go to this allocation.
+        // Rewards per token will be (totalSupply * issuanceRate^nBlocks - totalSupply) / allocatedTokens
+        // The first snapshot is after allocating, that is 2 blocks after the signal is minted:
+        // startRewardsPerToken = (10004000000 * 1.01227 ^ 2 - 10004000000) / 12500 = 122945.16
+        // The final snapshot is when we close the allocation, that happens 9 blocks later:
+        // endRewardsPerToken = (10004000000 * 1.01227 ^ 9 - 10004000000) / 12500 = 92861.24
+        // Then our expected rewards are (endRewardsPerToken - startRewardsPerToken) * 12500.
+        const expectedIndexingRewards = toGRT('913715958')
 
         // Close allocation. At this point rewards should be collected for that indexer
         const tx = await staking
@@ -618,19 +632,28 @@ describe('Rewards', () => {
         const destinationAddress = randomHexBytes(20)
         await staking.connect(indexer1.signer).setRewardsDestination(destinationAddress)
 
+        // Align with the epoch boundary
+        await advanceToNextEpoch(epochManager)
         // Setup
         await setupIndexerAllocation()
 
         // Jump
-        await advanceBlocks(await epochManager.epochLength())
+        await advanceToNextEpoch(epochManager)
 
         // Before state
         const beforeTokenSupply = await grt.totalSupply()
         const beforeIndexer1Stake = await staking.getIndexerStakedTokens(indexer1.address)
         const beforeDestinationBalance = await grt.balanceOf(destinationAddress)
         const beforeStakingBalance = await grt.balanceOf(staking.address)
 
-        const expectedIndexingRewards = toGRT('1471954234')
+        // All the rewards in this subgraph go to this allocation.
+        // Rewards per token will be (totalSupply * issuanceRate^nBlocks - totalSupply) / allocatedTokens
+        // The first snapshot is after allocating, that is 2 blocks after the signal is minted:
+        // startRewardsPerToken = (10004000000 * 1.01227 ^ 2 - 10004000000) / 12500 = 122945.16
+        // The final snapshot is when we close the allocation, that happens 9 blocks later:
+        // endRewardsPerToken = (10004000000 * 1.01227 ^ 9 - 10004000000) / 12500 = 92861.24
+        // Then our expected rewards are (endRewardsPerToken - startRewardsPerToken) * 12500.
+        const expectedIndexingRewards = toGRT('913715958')
 
         // Close allocation. At this point rewards should be collected for that indexer
         const tx = await staking
@@ -673,10 +696,13 @@ describe('Rewards', () => {
         }
         const tokensToDelegate = toGRT('2000')
 
+        // Align with the epoch boundary
+        await advanceToNextEpoch(epochManager)
+        // Setup the allocation and delegators
         await setupIndexerAllocationWithDelegation(tokensToDelegate, delegationParams)
 
         // Jump
-        await advanceBlocks(await epochManager.epochLength())
+        await advanceToNextEpoch(epochManager)
 
         // Before state
         const beforeTokenSupply = await grt.totalSupply()
@@ -693,8 +719,15 @@ describe('Rewards', () => {
 
         // Check that rewards are put into indexer stake (only indexer cut)
         // Check that rewards are put into delegators pool accordingly
-        // NOTE: calculated manually on a spreadsheet
-        const expectedIndexingRewards = toGRT('1454109066')
+
+        // All the rewards in this subgraph go to this allocation.
+        // Rewards per token will be (totalSupply * issuanceRate^nBlocks - totalSupply) / allocatedTokens
+        // The first snapshot is after allocating, that is 2 blocks after the signal is minted:
+        // startRewardsPerToken = (10004000000 * 1.01227 ^ 2 - 10004000000) / 14500 = 8466.995
+        // The final snapshot is when we close the allocation, that happens 4 blocks later:
+        // endRewardsPerToken = (10004000000 * 1.01227 ^ 4 - 10004000000) / 14500 = 34496.55
+        // Then our expected rewards are (endRewardsPerToken - startRewardsPerToken) * 14500.
+        const expectedIndexingRewards = toGRT('377428566.77')
         // Calculate delegators cut
         const indexerRewards = delegationParams.indexingRewardCut
           .mul(expectedIndexingRewards)
@@ -720,7 +753,7 @@ describe('Rewards', () => {
         await setupIndexerAllocation()
 
         // Jump
-        await advanceBlocks(await epochManager.epochLength())
+        await advanceToNextEpoch(epochManager)
 
         // Close allocation. At this point rewards should be collected for that indexer
         const tx = staking.connect(indexer1.signer).closeAllocation(allocationID, randomHexBytes())
@@ -754,7 +787,8 @@ describe('Rewards', () => {
       await staking.connect(indexer1.signer).stake(tokensToAllocate)
       await staking
         .connect(indexer1.signer)
-        .allocate(
+        .allocateFrom(
+          indexer1.address,
           subgraphDeploymentID1,
           tokensToAllocate,
           allocationID,
@@ -763,7 +797,7 @@ describe('Rewards', () => {
         )
 
       // Jump
-      await advanceBlocks(await epochManager.epochLength())
+      await advanceToNextEpoch(epochManager)
 
       // Remove all signal from the subgraph
       const curatorShares = await curation.getCuratorSignal(curator1.address, subgraphDeploymentID1)
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
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,14 @@ task('contracts:functions', 'Print function hashes for contracts')`
`20`	`20`	`console.log(fnSig, '->', hre.ethers.utils.id(fnSig).slice(0, 10))`
`21`	`21`	`}`
`22`	`22`	`}`
	`23`	`+`
	`24`	`+ console.log('## GNS ##')`
	`25`	`+ for (const fn of Object.entries(env.contracts.GNS.functions)) {`
	`26`	`+ const [fnSig] = fn`
	`27`	`+ if (fnSig.indexOf('(') != -1) {`
	`28`	`+ console.log(fnSig, '->', hre.ethers.utils.id(fnSig).slice(0, 10))`
	`29`	`+ }`
	`30`	`+ }`
`23`	`31`	`})`
`24`	`32`
`25`	`33`	`task('contracts:layout', 'Display storage layout').setAction(async (_, hre) => {`