Add burning nSignal to the curator simulator

Author: davekay100

cli/commands/simulations/curatorSimulation.ts

@@ -1,10 +1,10 @@
 import consola from 'consola'
 import { parseGRT } from '@graphprotocol/common-ts'
-import { Argv } from 'yargs'
+import yargs, { Argv } from 'yargs'
 
 import { sendTransaction } from '../../network'
 import { loadEnv, CLIArgs, CLIEnvironment } from '../../env'
-import { parseSubgraphsCSV, CurateSimulationTransaction } from './parseCSV'
+import { parseCreateSubgraphsCSV, CurateSimulationTransaction, parseUnsignalCSV } from './parseCSV'
 import { pinMetadataToIPFS, IPFS } from '../../helpers'
 
 const logger = consola.create({})
@@ -68,33 +68,69 @@ const curateOnSubgraphs = async (
   }
 }
 
-export const simulation = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
-  const txData = parseSubgraphsCSV(__dirname + cliArgs.path)
+const createAndSignal = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
+  const txData = parseCreateSubgraphsCSV(__dirname + cliArgs.path)
   logger.log(`Running the curation simulator`)
   await createSubgraphs(cli, txData)
   await curateOnSubgraphs(cli, txData, cliArgs.firstSubgraphNumber)
 }
 
+const unsignal = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
+  const txData = parseUnsignalCSV(__dirname + cliArgs.path)
+  logger.log(`Burning nSignal for ${txData.length} accounts...`)
+  for (let i = 0; i < txData.length; i++) {
+    const account = txData[i].account
+    const subgraphNumber = txData[i].subgraphNumber
+    const nSignal = parseGRT(txData[i].amount)
+    const gns = cli.contracts.GNS
+    logger.log(`Burning nSignal for ${account}-${subgraphNumber}...`)
+    await sendTransaction(cli.wallet, gns, 'burnNSignal', ...[account, subgraphNumber, nSignal])
+  }
+}
 export const curatorSimulationCommand = {
   command: 'curatorSimulation',
   describe: 'Simulates creating multiple subgraphs and then curating on them, from a csv file',
-  builder: (yargs: Argv) => {
+  builder: (yargs: Argv): yargs.Argv => {
     return yargs
-      .option('path', {
-        description: 'Path of the csv file relative to this folder',
-        type: 'string',
-        requiresArg: true,
-        demandOption: true,
+      .command({
+        command: 'createAndSignal',
+        describe: 'Create and signal on subgraphs by reading data from a csv file',
+        builder: (yargs: Argv) => {
+          return yargs
+            .option('path', {
+              description: 'Path of the csv file relative to this folder',
+              type: 'string',
+              requiresArg: true,
+              demandOption: true,
+            })
+            .option('firstSubgraphNumber', {
+              description: 'First subgraph to be newly curated',
+              type: 'number',
+              requiresArg: true,
+              demandOption: true,
+            })
+        },
+        handler: async (argv: CLIArgs): Promise<void> => {
+          return createAndSignal(await loadEnv(argv), argv)
+        },
       })
-      .option('firstSubgraphNumber', {
-        description:
-          'First subgraph to be newly curated. Used so we can curate the right subgraphs',
-        type: 'number',
-        requiresArg: true,
-        demandOption: true,
+      .command({
+        command: 'unsignal',
+        describe: 'Unsignal on a bunch of subgraphs by reading data from a CSV',
+        builder: (yargs: Argv) => {
+          return yargs.option('path', {
+            description: 'Path of the csv file relative to this folder',
+            type: 'string',
+            requiresArg: true,
+            demandOption: true,
+          })
+        },
+        handler: async (argv: CLIArgs): Promise<void> => {
+          return unsignal(await loadEnv(argv), argv)
+        },
       })
   },
-  handler: async (argv: CLIArgs): Promise<void> => {
-    return simulation(await loadEnv(argv), argv)
+  handler: (): void => {
+    yargs.showHelp()
   },
 }

cli/commands/simulations/parseCSV.ts

@@ -11,7 +11,7 @@ export interface CurateSimulationTransaction {
 
 // Parses a CSV where the titles are ordered like so:
 //  displayName,description,subgraphID,signal,codeRepository,image,website
-export function parseSubgraphsCSV(path: string) {
+export function parseCreateSubgraphsCSV(path: string): Array<CurateSimulationTransaction> {
   const data = fs.readFileSync(path, 'utf8')
   const subgraphs = data.split('\n').map((e) => e.trim())
   const txData: Array<CurateSimulationTransaction> = []
@@ -45,3 +45,28 @@ export function parseSubgraphsCSV(path: string) {
   }
   return txData
 }
+
+export interface UnsignalTransaction {
+  account: string
+  subgraphNumber: string
+  amount: string
+}
+
+// Parses a CSV for unsignalling
+export function parseUnsignalCSV(path: string): Array<UnsignalTransaction> {
+  const data = fs.readFileSync(path, 'utf8')
+  const subgraphs = data.split('\n').map((e) => e.trim())
+  const txData: Array<UnsignalTransaction> = []
+  for (let i = 1; i < subgraphs.length; i++) {
+    // skip the csv title line by starting at 1
+    const csvData = subgraphs[i]
+    const [account, subgraphNumber, amount] = csvData.split(',').map((e) => e.trim())
+    const data: UnsignalTransaction = {
+      account: account,
+      subgraphNumber: subgraphNumber,
+      amount: amount,
+    }
+    txData.push(data)
+  }
+  return txData
+}

cli/mockData/bulkPhaseData/phase1-unsignal.csv

@@ -0,0 +1,19 @@
+Account,Subgraph Number,Amount
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,0,300000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,1,100000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,2,100000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,3,100000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,4,100000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,5,50000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,6,25000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,7,80000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,8,150000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,9,150000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,10,150000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,11,150000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,12,200000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,13,200000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,14,200000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,15,100000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,16,200000
+0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1,17,200000