Merge pull request #819 from graphprotocol/ab/snapshot-on-collect

fix: update snapshot on query fee collect

Author: tmigone

contracts/staking/Staking.sol

@@ -1023,6 +1023,7 @@ abstract contract Staking is StakingV3Storage, GraphUpgradeable, IStakingBase, M
                 // Transfer and call collect()
                 // This function transfer tokens to a trusted protocol contracts
                 // Then we call collect() to do the transfer bookeeping
+                rewardsManager().onSubgraphSignalUpdate(_subgraphDeploymentID);
                 TokenUtils.pushTokens(_graphToken, address(curation), curationFees);
                 curation.collect(_subgraphDeploymentID, curationFees);
             }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/contracts",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "description": "Contracts for the Graph Protocol",
   "directories": {
     "test": "test"

test/rewards/rewards.test.ts

@@ -2,7 +2,6 @@ import { expect } from 'chai'
 import { constants, BigNumber } from 'ethers'
 import { BigNumber as BN } from 'bignumber.js'
 
-import { deployContract } from '../lib/deployment'
 import { NetworkFixture } from '../lib/fixtures'
 
 import { Curation } from '../../build/types/Curation'
@@ -23,6 +22,7 @@ import {
   Account,
   advanceToNextEpoch,
   provider,
+  advanceBlock,
 } from '../lib/testHelpers'
 
 const MAX_PPM = 1000000
@@ -39,6 +39,7 @@ describe('Rewards', () => {
   let indexer1: Account
   let indexer2: Account
   let oracle: Account
+  let assetHolder: Account
 
   let fixture: NetworkFixture
 
@@ -131,7 +132,8 @@ describe('Rewards', () => {
   }
 
   before(async function () {
-    ;[delegator, governor, curator1, curator2, indexer1, indexer2, oracle] = await getAccounts()
+    ;[delegator, governor, curator1, curator2, indexer1, indexer2, oracle, assetHolder] =
+      await getAccounts()
 
     fixture = new NetworkFixture()
     ;({ grt, curation, epochManager, staking, rewardsManager } = await fixture.load(
@@ -142,7 +144,7 @@ describe('Rewards', () => {
     await rewardsManager.connect(governor.signer).setIssuancePerBlock(ISSUANCE_PER_BLOCK)
 
     // Distribute test funds
-    for (const wallet of [indexer1, indexer2, curator1, curator2]) {
+    for (const wallet of [indexer1, indexer2, curator1, curator2, assetHolder]) {
       await grt.connect(governor.signer).mint(wallet.address, toGRT('1000000'))
       await grt.connect(wallet.signer).approve(staking.address, toGRT('1000000'))
       await grt.connect(wallet.signer).approve(curation.address, toGRT('1000000'))
@@ -955,4 +957,69 @@ describe('Rewards', () => {
       expect(event1.amount).eq(event2.amount)
     })
   })
+
+  describe('rewards progression when collecting query fees', function () {
+    it('collect query fees with two subgraphs and one allocation', async function () {
+      async function getRewardsAccrual(subgraphs) {
+        const [sg1, sg2] = await Promise.all(
+          subgraphs.map((sg) => rewardsManager.getAccRewardsForSubgraph(sg)),
+        )
+        return {
+          sg1,
+          sg2,
+          all: sg1.add(sg2),
+        }
+      }
+
+      // set curation percentage
+      await staking.setCurationPercentage(100000)
+
+      // allow the asset holder
+      const tokensToCollect = toGRT('10000')
+      await staking.connect(governor.signer).setAssetHolder(assetHolder.address, true)
+
+      // signal in two subgraphs in the same block
+      const subgraphs = [subgraphDeploymentID1, subgraphDeploymentID2]
+      for (const sub of subgraphs) {
+        await curation.connect(curator1.signer).mint(sub, toGRT('1500'), 0)
+      }
+
+      // snapshot block before any accrual (we substract 1 because accrual starts after the first mint happens)
+      const b1 = await epochManager.blockNum().then((x) => x.toNumber() - 1)
+
+      // allocate
+      const tokensToAllocate = toGRT('12500')
+      await staking
+        .connect(indexer1.signer)
+        .multicall([
+          await staking.populateTransaction.stake(tokensToAllocate).then((tx) => tx.data),
+          await staking.populateTransaction
+            .allocateFrom(
+              indexer1.address,
+              subgraphDeploymentID1,
+              tokensToAllocate,
+              allocationID1,
+              metadata,
+              await channelKey1.generateProof(indexer1.address),
+            )
+            .then((tx) => tx.data),
+        ])
+
+      // move time fwd
+      await advanceBlock()
+
+      // collect funds into staking for that sub
+      await staking.connect(assetHolder.signer).collect(tokensToCollect, allocationID1)
+
+      // check rewards diff
+      await rewardsManager.getRewards(allocationID1).then(formatGRT)
+
+      await advanceBlock()
+      const accrual = await getRewardsAccrual(subgraphs)
+      const b2 = await epochManager.blockNum().then((x) => x.toNumber())
+
+      // round comparison because there is a small precision error due to dividing and accrual per signal
+      expect(toRound(accrual.all)).eq(toRound(ISSUANCE_PER_BLOCK.mul(b2 - b1)))
+    })
+  })
 })