cli: organize commands to list and claim rebates

Author: abarmat

hardhat.config.ts

@@ -27,7 +27,7 @@ import '@typechain/hardhat'
 const SKIP_LOAD = process.env.SKIP_LOAD === 'true'
 
 if (!SKIP_LOAD) {
-  ;['contracts', 'misc', 'query', 'deployment'].forEach((folder) => {
+  ;['contracts', 'misc', 'query', 'deployment', 'actions'].forEach((folder) => {
     const tasksPath = path.join(__dirname, 'tasks', folder)
     fs.readdirSync(tasksPath)
       .filter((pth) => pth.includes('.ts'))

package.json

@@ -38,6 +38,7 @@
     "@typescript-eslint/eslint-plugin": "^4.0.0",
     "@typescript-eslint/parser": "^4.0.0",
     "@typescript-eslint/typescript-estree": "^4.0.0",
+    "@urql/core": "^2.1.3",
     "axios": "^0.21.1",
     "bignumber.js": "^9.0.0",
     "chai": "^4.3.4",
@@ -55,13 +56,15 @@
     "eslint-plugin-standard": "^4.1.0",
     "ethereum-waffle": "^3.3.0",
     "ethlint": "^1.2.5",
+    "graphql-tag": "^2.12.4",
     "hardhat": "^2.2.0",
     "hardhat-abi-exporter": "^2.2.0",
     "hardhat-contract-sizer": "^2.0.3",
     "hardhat-gas-reporter": "^1.0.4",
     "husky": "^4.3.8",
     "inquirer": "^8.0.0",
     "ipfs-http-client": "47.0.1",
+    "isomorphic-fetch": "^3.0.0",
     "lint-staged": "^10.5.4",
     "minimist": "^1.2.5",
     "p-queue": "^6.6.1",

tasks/actions/rebates.ts

@@ -0,0 +1,44 @@
+import { createClient } from '@urql/core'
+import gql from 'graphql-tag'
+import fetch from 'isomorphic-fetch'
+import { task } from 'hardhat/config'
+import { HardhatRuntimeEnvironment } from 'hardhat/types'
+
+const range = (min, max) => [...Array(max - min + 1).keys()].map((i) => i + min)
+
+task('action:claim-rebates', 'Claim rebates')
+  .addParam('poolRange', 'Pool range to claim in "a,b" format')
+  .setAction(async ({ poolRange }, hre: HardhatRuntimeEnvironment) => {
+    // const { contracts } = hre
+
+    // Parse input
+    const [fromEpoch, toEpoch] = poolRange.split(',').map((e) => parseInt(e))
+    const epochs = range(fromEpoch, toEpoch)
+    console.log(`Scanning rebate pools (from ${fromEpoch} to ${toEpoch})...`)
+
+    // Get allocations
+    const url = 'https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network-mainnet'
+    const networkSubgraph = createClient({
+      url,
+      fetch,
+      requestPolicy: 'network-only',
+    })
+    const query = gql`
+      query ($epochs: [Int!]!) {
+        allocations(first: 1000, where: { closedAtEpoch_in: $epochs, status_not: "Claimed" }) {
+          id
+        }
+      }
+    `
+    const res = await networkSubgraph.query(query, { epochs }).toPromise()
+    const allocationIDs = res.data.allocations.map((allo) => allo.id)
+    console.log(`Found ${allocationIDs.length} allocations`)
+    console.log(allocationIDs)
+
+    // Claim
+    // TODO: perform gas estimation
+    // TODO: add confirmation question
+    // TODO: batch into multiple calls
+    // const tx = await contracts.Staking.claimMany(allocationIDs, false)
+    // console.log(tx.hash)
+  })

tasks/query/rebates.ts

@@ -1,3 +1,5 @@
+import { BigNumber } from 'ethers'
+import { parseEther } from 'ethers/lib/utils'
 import Table from 'cli-table'
 import PQueue from 'p-queue'
 import { task } from 'hardhat/config'
@@ -6,32 +8,53 @@ import '@nomiclabs/hardhat-ethers'
 
 import '../gre'
 
-task('query:rebates', 'List rebate pools').setAction(async (_, hre: HardhatRuntimeEnvironment) => {
-  const { contracts } = hre
-  const { formatEther } = hre.ethers.utils
+task('query:rebates', 'List rebate pools')
+  .addParam('count', 'Number of pools to query')
+  .setAction(async ({ count }, hre: HardhatRuntimeEnvironment) => {
+    const { contracts } = hre
+    const { formatEther } = hre.ethers.utils
 
-  const table = new Table({
-    head: ['Epoch', 'Total Fees', 'Claimed Amount', 'Unclaimed Allocs'],
-    colWidths: [10, 40, 40, 20],
-  })
+    const table = new Table({
+      head: ['Epoch', 'Fees', 'Claimed', 'Allos', 'Done (%)'],
+      colWidths: [10, 40, 40, 10, 10],
+    })
+
+    // Get epoch data
+    const currentEpoch = await contracts.EpochManager.currentEpoch()
 
-  // Get epoch data
-  const currentEpoch = await contracts.EpochManager.currentEpoch()
+    // Summaries
+    let totalAllos = 0
+    let totalUnclaimed = BigNumber.from(0)
 
-  // Get rebates
-  const queue = new PQueue({ concurrency: 4 })
-  for (let i = 0; i < 5; i++) {
-    const epoch = currentEpoch.sub(i)
-    const rebatePool = await contracts.Staking.rebates(epoch)
-    table.push([
-      epoch,
-      formatEther(rebatePool.fees),
-      formatEther(rebatePool.claimedRewards),
-      rebatePool.unclaimedAllocationsCount,
-    ])
-  }
-  await queue.onIdle()
+    // Get rebates
+    const items = []
+    const queue = new PQueue({ concurrency: 10 })
+    for (let i = 0; i < count; i++) {
+      queue.add(async () => {
+        // Calculations
+        const epoch = currentEpoch.sub(i).toNumber()
+        const rebatePool = await contracts.Staking.rebates(epoch)
+        const shareClaimed = rebatePool.fees.gt(0)
+          ? formatEther(rebatePool.claimedRewards.mul(parseEther('1')).div(rebatePool.fees))
+          : '1'
+        // Add to table
+        items.push([
+          epoch,
+          formatEther(rebatePool.fees),
+          formatEther(rebatePool.claimedRewards),
+          rebatePool.unclaimedAllocationsCount,
+          Math.round(parseFloat(shareClaimed) * 100),
+        ])
+        // Add to summaries
+        totalAllos += rebatePool.unclaimedAllocationsCount
+        totalUnclaimed = totalUnclaimed.add(rebatePool.fees.sub(rebatePool.claimedRewards))
+      })
+    }
+    await queue.onIdle()
 
-  // Display
-  console.log(table.toString())
-})
+    // Display
+    table.push(...items.sort((a, b) => b[0] - a[0]))
+    console.log(table.toString())
+    console.log(`> Unclaimed Allos: ${totalAllos}`)
+    console.log(`> Unclaimed Fees: ${formatEther(totalUnclaimed)}`)
+  })

yarn.lock

@@ -1218,6 +1218,14 @@
     "@graphql-typed-document-node/core" "^3.1.0"
     wonka "^4.0.14"
 
+"@urql/core@^2.1.3":
+  version "2.1.3"
+  resolved "https://registry.yarnpkg.com/@urql/core/-/core-2.1.3.tgz#fd8514ce28c1f8cf8e99a03b86a3df217c132290"
+  integrity sha512-CzrTMhO5SG7qdAaS3B5/g1TPH5k7326GHIyta1owT2vzxX9ev8YytxOE5m73EuacxIfF7qVZFhCzY+rubOlI0w==
+  dependencies:
+    "@graphql-typed-document-node/core" "^3.1.0"
+    wonka "^4.0.14"
+
 "@urql/[email protected]":
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/@urql/exchange-execute/-/exchange-execute-1.0.1.tgz#4cda7cbb8130c6c99f035927ca5d4756685f1ab4"
@@ -5518,6 +5526,13 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/graphql-tag/-/graphql-tag-2.11.0.tgz#1deb53a01c46a7eb401d6cb59dec86fa1cccbffd"
   integrity sha512-VmsD5pJqWJnQZMUeRwrDhfgoyqcfwEkvtpANqcoUG8/tOLkwNgU9mzub/Mc78OJMhHjx7gfAMTxzdG43VGg3bA==
 
+graphql-tag@^2.12.4:
+  version "2.12.4"
+  resolved "https://registry.yarnpkg.com/graphql-tag/-/graphql-tag-2.12.4.tgz#d34066688a4f09e72d6f4663c74211e9b4b7c4bf"
+  integrity sha512-VV1U4O+9x99EkNpNmCUV5RZwq6MnK4+pGbRYWG+lA/m3uo7TSqJF81OkcOP148gFP6fzdl7JWYBrwWVTS9jXww==
+  dependencies:
+    tslib "^2.1.0"
+
 [email protected]:
   version "15.4.0"
   resolved "https://registry.yarnpkg.com/graphql/-/graphql-15.4.0.tgz#e459dea1150da5a106486ba7276518b5295a4347"
@@ -6577,6 +6592,14 @@ isobject@^3.0.0, isobject@^3.0.1:
   resolved "https://registry.yarnpkg.com/isobject/-/isobject-3.0.1.tgz#4e431e92b11a9731636aa1f9c8d1ccbcfdab78df"
   integrity sha1-TkMekrEalzFjaqH5yNHMvP2reN8=
 
+isomorphic-fetch@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/isomorphic-fetch/-/isomorphic-fetch-3.0.0.tgz#0267b005049046d2421207215d45d6a262b8b8b4"
+  integrity sha512-qvUtwJ3j6qwsF3jLxkZ72qCgjMysPzDfeV240JHiGZsANBYd+EEuu35v7dfrJ9Up0Ak07D7GGSkGhCHTqg/5wA==
+  dependencies:
+    node-fetch "^2.6.1"
+    whatwg-fetch "^3.4.1"
+
 isstream@~0.1.2:
   version "0.1.2"
   resolved "https://registry.yarnpkg.com/isstream/-/isstream-0.1.2.tgz#47e63f7af55afa6f92e1500e690eb8b8529c099a"
@@ -8048,7 +8071,7 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.1.2.tgz#ab884e8e7e57e38a944753cec706f788d1768bb5"
   integrity sha1-q4hOjn5X44qUR1POxwb3iNF2i7U=
 
-[email protected], node-fetch@^2.6.0:
+[email protected], node-fetch@^2.6.0, node-fetch@^2.6.1:
   version "2.6.1"
   resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.1.tgz#045bd323631f76ed2e2b55573394416b639a0052"
   integrity sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==
@@ -10851,6 +10874,11 @@ tslib@^1.8.1, tslib@^1.9.0, tslib@^1.9.3:
   resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.14.1.tgz#cf2d38bdc34a134bcaf1091c41f6619e2f672d00"
   integrity sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==
 
+tslib@^2.1.0:
+  version "2.3.0"
+  resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.3.0.tgz#803b8cdab3e12ba581a4ca41c8839bbb0dacb09e"
+  integrity sha512-N82ooyxVNm6h1riLCoyS9e3fuJ3AMG2zIZs2Gd1ATcSFjSA23Q0fzjjZeh0jbJvWVDZ0cJT8yaNNaaXHzueNjg==
+
 [email protected]:
   version "0.0.1"
   resolved "https://registry.yarnpkg.com/tsort/-/tsort-0.0.1.tgz#e2280f5e817f8bf4275657fd0f9aebd44f5a2786"
@@ -11803,6 +11831,11 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/whatwg-fetch/-/whatwg-fetch-2.0.4.tgz#dde6a5df315f9d39991aa17621853d720b85566f"
   integrity sha512-dcQ1GWpOD/eEQ97k66aiEVpNnapVj90/+R+SXTPYGHpYBBypfKJEQjLrvMZ7YXbKm21gXd4NcuxUTjiv1YtLng==
 
+whatwg-fetch@^3.4.1:
+  version "3.6.2"
+  resolved "https://registry.yarnpkg.com/whatwg-fetch/-/whatwg-fetch-3.6.2.tgz#dced24f37f2624ed0281725d51d0e2e3fe677f8c"
+  integrity sha512-bJlen0FcuU/0EMLrdbJ7zOnW6ITZLrZMIarMUVmdKtsGvZna8vxKYaexICWPfZ8qwf9fzNq+UEIZrnSaApt6RA==
+
 which-boxed-primitive@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz#13757bc89b209b049fe5d86430e21cf40a89a8e6"