test: add a test for rewards distribution accrual with multiple allocations

Author: abarmat

test/rewards/rewards.test.ts

@@ -50,12 +50,15 @@ describe('Rewards', () => {
   let rewardsManagerMock: RewardsManagerMock
 
   // Derive some channel keys for each indexer used to sign attestations
-  const channelKey = deriveChannelKey()
+  const channelKey1 = deriveChannelKey()
+  const channelKey2 = deriveChannelKey()
 
   const subgraphDeploymentID1 = randomHexBytes()
   const subgraphDeploymentID2 = randomHexBytes()
 
-  const allocationID = channelKey.address
+  const allocationID1 = channelKey1.address
+  const allocationID2 = channelKey2.address
+
   const metadata = HashZero
 
   const ISSUANCE_RATE_PERIODS = 4 // blocks required to issue 5% rewards
@@ -97,6 +100,10 @@ describe('Rewards', () => {
 
     async accrued() {
       const nBlocks = await this.elapsedBlocks()
+      return this.accruedByElapsed(nBlocks)
+    }
+
+    async accruedByElapsed(nBlocks: BigNumber | number) {
       const n = getRewardsPerSignal(
         new BN(this.totalSupply.toString()),
         new BN(ISSUANCE_RATE_PER_BLOCK.toString()).div(1e18),
@@ -395,9 +402,9 @@ describe('Rewards', () => {
             indexer1.address,
             subgraphDeploymentID1,
             tokensToAllocate,
-            allocationID,
+            allocationID1,
             metadata,
-            await channelKey.generateProof(indexer1.address),
+            await channelKey1.generateProof(indexer1.address),
           )
 
         // Jump
@@ -433,9 +440,9 @@ describe('Rewards', () => {
             indexer1.address,
             subgraphDeploymentID1,
             tokensToAllocate,
-            allocationID,
+            allocationID1,
             metadata,
-            await channelKey.generateProof(indexer1.address),
+            await channelKey1.generateProof(indexer1.address),
           )
 
         // Jump
@@ -477,16 +484,16 @@ describe('Rewards', () => {
             indexer1.address,
             subgraphDeploymentID1,
             tokensToAllocate,
-            allocationID,
+            allocationID1,
             metadata,
-            await channelKey.generateProof(indexer1.address),
+            await channelKey1.generateProof(indexer1.address),
           )
 
         // Jump
         await advanceBlocks(ISSUANCE_RATE_PERIODS)
 
         // Rewards
-        const contractRewards = await rewardsManager.getRewards(allocationID)
+        const contractRewards = await rewardsManager.getRewards(allocationID1)
 
         // We trust using this function in the test because we tested it
         // standalone in a previous test
@@ -523,9 +530,9 @@ describe('Rewards', () => {
             indexer1.address,
             subgraphDeploymentID1,
             tokensToAllocate,
-            allocationID,
+            allocationID1,
             metadata,
-            await channelKey.generateProof(indexer1.address),
+            await channelKey1.generateProof(indexer1.address),
           )
       }
 
@@ -566,9 +573,9 @@ describe('Rewards', () => {
             indexer1.address,
             subgraphDeploymentID1,
             tokensToAllocate,
-            allocationID,
+            allocationID1,
             metadata,
-            await channelKey.generateProof(indexer1.address),
+            await channelKey1.generateProof(indexer1.address),
           )
       }
 
@@ -599,11 +606,11 @@ describe('Rewards', () => {
         // Close allocation. At this point rewards should be collected for that indexer
         const tx = await staking
           .connect(indexer1.signer)
-          .closeAllocation(allocationID, randomHexBytes())
+          .closeAllocation(allocationID1, randomHexBytes())
         const receipt = await tx.wait()
         const event = rewardsManager.interface.parseLog(receipt.logs[1]).args
         expect(event.indexer).eq(indexer1.address)
-        expect(event.allocationID).eq(allocationID)
+        expect(event.allocationID1).eq(allocationID1)
         expect(event.epoch).eq(await epochManager.currentEpoch())
         expect(toRound(event.amount)).eq(toRound(expectedIndexingRewards))
 
@@ -658,11 +665,11 @@ describe('Rewards', () => {
         // Close allocation. At this point rewards should be collected for that indexer
         const tx = await staking
           .connect(indexer1.signer)
-          .closeAllocation(allocationID, randomHexBytes())
+          .closeAllocation(allocationID1, randomHexBytes())
         const receipt = await tx.wait()
         const event = rewardsManager.interface.parseLog(receipt.logs[1]).args
         expect(event.indexer).eq(indexer1.address)
-        expect(event.allocationID).eq(allocationID)
+        expect(event.allocationID1).eq(allocationID1)
         expect(event.epoch).eq(await epochManager.currentEpoch())
         expect(toRound(event.amount)).eq(toRound(expectedIndexingRewards))
 
@@ -710,7 +717,7 @@ describe('Rewards', () => {
         const beforeIndexer1Stake = await staking.getIndexerStakedTokens(indexer1.address)
 
         // Close allocation. At this point rewards should be collected for that indexer
-        await staking.connect(indexer1.signer).closeAllocation(allocationID, randomHexBytes())
+        await staking.connect(indexer1.signer).closeAllocation(allocationID1, randomHexBytes())
 
         // After state
         const afterTokenSupply = await grt.totalSupply()
@@ -756,10 +763,10 @@ describe('Rewards', () => {
         await advanceToNextEpoch(epochManager)
 
         // Close allocation. At this point rewards should be collected for that indexer
-        const tx = staking.connect(indexer1.signer).closeAllocation(allocationID, randomHexBytes())
+        const tx = staking.connect(indexer1.signer).closeAllocation(allocationID1, randomHexBytes())
         await expect(tx)
           .emit(rewardsManager, 'RewardsDenied')
-          .withArgs(indexer1.address, allocationID, await epochManager.currentEpoch())
+          .withArgs(indexer1.address, allocationID1, await epochManager.currentEpoch())
       })
     })
   })
@@ -791,9 +798,9 @@ describe('Rewards', () => {
           indexer1.address,
           subgraphDeploymentID1,
           tokensToAllocate,
-          allocationID,
+          allocationID1,
           metadata,
-          await channelKey.generateProof(indexer1.address),
+          await channelKey1.generateProof(indexer1.address),
         )
 
       // Jump
@@ -804,7 +811,58 @@ describe('Rewards', () => {
       await curation.connect(curator1.signer).burn(subgraphDeploymentID1, curatorShares, 0)
 
       // Close allocation. At this point rewards should be collected for that indexer
-      await staking.connect(indexer1.signer).closeAllocation(allocationID, randomHexBytes())
+      await staking.connect(indexer1.signer).closeAllocation(allocationID1, randomHexBytes())
+    })
+  })
+
+  describe('multiple allocations', function () {
+    it('two simultanous-similar allocations should get same amount of rewards', async function () {
+      await advanceToNextEpoch(epochManager)
+
+      // Setup
+      await epochManager.setEpochLength(10)
+
+      // Update total signalled
+      const signalled1 = toGRT('1500')
+      await curation.connect(curator1.signer).mint(subgraphDeploymentID1, signalled1, 0)
+
+      // Stake
+      const tokensToStake = toGRT('12500')
+      await staking.connect(indexer1.signer).stake(tokensToStake)
+
+      // Allocate simultaneously
+      const tokensToAlloc = toGRT('5000')
+      const tx1 = await staking.populateTransaction.allocateFrom(
+        indexer1.address,
+        subgraphDeploymentID1,
+        tokensToAlloc,
+        allocationID1,
+        metadata,
+        await channelKey1.generateProof(indexer1.address),
+      )
+      const tx2 = await staking.populateTransaction.allocateFrom(
+        indexer1.address,
+        subgraphDeploymentID1,
+        tokensToAlloc,
+        allocationID2,
+        metadata,
+        await channelKey2.generateProof(indexer1.address),
+      )
+      await staking.connect(indexer1.signer).multicall([tx1.data, tx2.data])
+
+      // Jump
+      await advanceToNextEpoch(epochManager)
+
+      // Close allocations simultaneously
+      const tx3 = await staking.populateTransaction.closeAllocation(allocationID1, randomHexBytes())
+      const tx4 = await staking.populateTransaction.closeAllocation(allocationID2, randomHexBytes())
+      const tx5 = await staking.connect(indexer1.signer).multicall([tx3.data, tx4.data])
+
+      // Both allocations should receive the same amount of rewards
+      const receipt = await tx5.wait()
+      const event1 = rewardsManager.interface.parseLog(receipt.logs[1]).args
+      const event2 = rewardsManager.interface.parseLog(receipt.logs[5]).args
+      expect(event1.amount).eq(event2.amount)
     })
   })
 })