Add a contract for governance proposals (#362)

Introduce a contract to inscribe proposals made effective by the Graph Council.

The proposals are IPFS hash links that can contain metadata in arbitrary format with its full description.

Co-authored-by: David Kajpust <[email protected]>

Author: abarmat

.eslintrc

@@ -10,6 +10,10 @@
     "no-extra-semi": "off",
     "@typescript-eslint/no-extra-semi": "warn",
     "@typescript-eslint/no-inferrable-types": "warn",
-    "@typescript-eslint/no-empty-function": "warn"
-  }
+    "@typescript-eslint/no-empty-function": "warn",
+    "no-only-tests/no-only-tests": "error"
+  },
+  "plugins": [
+    "no-only-tests"
+  ]
 }

addresses.json

@@ -521,6 +521,22 @@
       "creationCodeHash": "0x26a6f47e71ad242e264768571ce7223bf5a86fd0113ab6cb8200f65820232904",
       "runtimeCodeHash": "0xd5330527cfb09df657adc879d8ad704ce6b8d5917265cabbd3eb073d1399f122",
       "txHash": "0xca463b34d7967c4351d24b2af779817bd1da75e53a48957cfa32abd1ebf3a56c"
+    },
+    "GraphGovernance": {
+      "address": "0x47241861A3918eaa9097c0345bb5A91660D7AEE1",
+      "initArgs": [
+        "0x1679a1d1caf1252ba43fb8fc17ebf914a0c725ae"
+      ],
+      "creationCodeHash": "0xa02709eb59b9cca8bee1271845b42db037dc1d042dad93410ba532d378a7c79f",
+      "runtimeCodeHash": "0xdb307489fd9a4a438b5b48909e12020b209280ad777561c0a7451655db097e75",
+      "txHash": "0x5101e33eb13504780b225a2557a7062bef93cada0838937e02e879fb3d5c2c01",
+      "proxy": true,
+      "implementation": {
+        "address": "0xa96F8468362e6A109ABFaAF6BBfDa303347B450e",
+        "creationCodeHash": "0x5bd7ee7fbf6eb49914ffc91c747d18c0909ca18c495a8b163499ebfdd82b29d2",
+        "runtimeCodeHash": "0xd77099bdfc3f66aec158303be46e92f8e434271d6b0c7643753cd8ac96b460b9",
+        "txHash": "0xb12705249777b5d955dd25ea7aebf46c5d1e3062b10bc9a0a5755b40f55e11e9"
+      }
     }
   }
-}
+}

cli/address-book.ts

@@ -5,8 +5,8 @@ const { AddressZero } = constants
 
 export type AddressBookEntry = {
   address: string
-  constructorArgs?: Array<{ name: string; value: string }>
-  initArgs?: Array<{ name: string; value: string }>
+  constructorArgs?: Array<string>
+  initArgs?: Array<string>
   creationCodeHash?: string
   runtimeCodeHash?: string
   txHash?: string

cli/commands/contracts/governance.ts

@@ -0,0 +1,123 @@
+import consola from 'consola'
+import yargs, { Argv } from 'yargs'
+
+import { sendTransaction } from '../../network'
+import { loadEnv, CLIArgs, CLIEnvironment } from '../../env'
+
+const logger = consola.create({})
+
+export const createProposal = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
+  const id = cliArgs.id
+  const votes = cliArgs.votes
+  const metadata = cliArgs.metadata
+  const resolution = cliArgs.resolution
+  const governance = cli.contracts.Governance
+
+  logger.log(`Creating proposal ${id}...`)
+  await sendTransaction(cli.wallet, governance, 'createProposal', [id, votes, metadata, resolution])
+}
+
+export const upgradeProposal = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
+  const id = cliArgs.id
+  const votes = cliArgs.votes
+  const metadata = cliArgs.metadata
+  const resolution = cliArgs.resolution
+  const governance = cli.contracts.Governance
+
+  logger.log(`Upgrade proposal ${id}...`)
+  await sendTransaction(cli.wallet, governance, 'upgradeProposal', [
+    id,
+    votes,
+    metadata,
+    resolution,
+  ])
+}
+
+export const governanceCommand = {
+  command: 'governance',
+  describe: 'Graph governance contract calls',
+  builder: (yargs: Argv): yargs.Argv => {
+    return yargs
+      .command({
+        command: 'createProposal',
+        describe: 'Create a proposal',
+        builder: (yargs: Argv): yargs.Argv => {
+          return yargs
+            .option('id', {
+              description: 'Proposal ID',
+              type: 'string',
+              requiresArg: true,
+              demandOption: true,
+            })
+            .option('votes', {
+              description: 'IPFS hash in bytes32',
+              type: 'string',
+              requiresArg: true,
+              demandOption: true,
+            })
+            .option('metadata', {
+              description: 'IPFS hash in bytes32',
+              type: 'string',
+              requiresArg: true,
+              demandOption: true,
+            })
+            .option('resolution', {
+              description: 'Resolution. 1 = Accepted, 2 = Rejected ',
+              type: 'number',
+              requiresArg: true,
+              demandOption: true,
+            })
+            .option('b', {
+              alias: 'build-tx',
+              description:
+                'Build the acceptProxy tx and print it. Then use tx data with a multisig',
+            })
+        },
+        handler: async (argv: CLIArgs): Promise<void> => {
+          return createProposal(await loadEnv(argv), argv)
+        },
+      })
+      .command({
+        command: 'upgradeProposal',
+        describe: 'Upgrade a proposal',
+        builder: (yargs: Argv): yargs.Argv => {
+          return yargs
+            .option('id', {
+              description: 'Proposal ID',
+              type: 'string',
+              requiresArg: true,
+              demandOption: true,
+            })
+            .option('votes', {
+              description: 'IPFS hash in bytes32',
+              type: 'string',
+              requiresArg: true,
+              demandOption: true,
+            })
+            .option('metadata', {
+              description: 'IPFS hash in bytes32',
+              type: 'string',
+              requiresArg: true,
+              demandOption: true,
+            })
+            .option('resolution', {
+              description: 'Resolution. 1 = Accepted, 2 = Rejected ',
+              type: 'number',
+              requiresArg: true,
+              demandOption: true,
+            })
+            .option('b', {
+              alias: 'build-tx',
+              description:
+                'Build the acceptProxy tx and print it. Then use tx data with a multisig',
+            })
+        },
+        handler: async (argv: CLIArgs): Promise<void> => {
+          return upgradeProposal(await loadEnv(argv), argv)
+        },
+      })
+  },
+  handler: (): void => {
+    yargs.showHelp()
+  },
+}

cli/commands/contracts/index.ts

@@ -1,4 +1,4 @@
-import yargs, { Argv } from 'yargs'
+import yargs, { Argv, command } from 'yargs'
 
 import { curationCommand } from './curation'
 import { serviceRegistryCommand } from './serviceRegistry'
@@ -9,6 +9,7 @@ import { graphTokenCommand } from './graphToken'
 import { gdaiCommand } from './gsr-gdai'
 import { stakingCommand } from './staking'
 import { anyCommand } from './any'
+import { governanceCommand } from './governance'
 
 import { CLIArgs } from '../../env'
 import { disputeManagerCommand } from './disputeManager'
@@ -28,6 +29,7 @@ export const contractsCommand = {
       .command(stakingCommand)
       .command(anyCommand)
       .command(disputeManagerCommand)
+      .command(governanceCommand)
   },
   handler: (argv: CLIArgs): void => {
     yargs.showHelp()

cli/commands/deploy.ts

@@ -1,18 +1,62 @@
 import yargs, { Argv } from 'yargs'
 
-import { deployContract } from '../network'
+import {
+  getContractAt,
+  deployContract,
+  deployContractAndSave,
+  deployContractWithProxy,
+  deployContractWithProxyAndSave,
+} from '../network'
 import { loadEnv, CLIArgs, CLIEnvironment } from '../env'
 import { logger } from '../logging'
 
 export const deploy = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
   const contractName = cliArgs.contract
   const initArgs = cliArgs.init
-
-  logger.log(`Deploying contract ${contractName}...`)
+  const deployType = cliArgs.type
+  const buildAcceptProxyTx = cliArgs.buildTx
 
   // Deploy contract
   const contractArgs = initArgs ? initArgs.split(',') : []
-  await deployContract(contractName, contractArgs, cli.wallet)
+  switch (deployType) {
+    case 'deploy':
+      logger.log(`Deploying contract ${contractName}...`)
+      await deployContract(contractName, contractArgs, cli.wallet)
+      break
+    case 'deploy-save':
+      logger.log(`Deploying contract ${contractName} and saving to address book...`)
+      await deployContractAndSave(contractName, contractArgs, cli.wallet, cli.addressBook)
+      break
+    case 'deploy-with-proxy':
+      // Get the GraphProxyAdmin to own the GraphProxy for this contract
+      const proxyAdminEntry = cli.addressBook.getEntry('GraphProxyAdmin')
+      if (!proxyAdminEntry) {
+        throw new Error('GraphProxyAdmin not detected in the config, must be deployed first!')
+      }
+      const proxyAdmin = getContractAt('GraphProxyAdmin', proxyAdminEntry.address)
+
+      logger.log(`Deploying contract ${contractName} with proxy ...`)
+      await deployContractWithProxy(
+        proxyAdmin,
+        contractName,
+        contractArgs,
+        cli.wallet,
+        buildAcceptProxyTx,
+      )
+      break
+    case 'deploy-with-proxy-save':
+      logger.log(`Deploying contract ${contractName} with proxy and saving to address book...`)
+      await deployContractWithProxyAndSave(
+        contractName,
+        contractArgs,
+        cli.wallet,
+        cli.addressBook,
+        buildAcceptProxyTx,
+      )
+      break
+    default:
+      logger.error('Please provide the correct option for deploy type')
+  }
 }
 
 export const deployCommand = {
@@ -33,6 +77,19 @@ export const deployCommand = {
         requiresArg: true,
         demandOption: true,
       })
+      .option('t', {
+        alias: 'type',
+        description: 'Choose deploy, deploy-save, deploy-with-proxy, deploy-with-proxy-save',
+        type: 'string',
+        requiresArg: true,
+        demandOption: true,
+      })
+      .option('b', {
+        alias: 'build-tx',
+        description: 'Build the acceptProxy tx and print it. Then use tx data with a multisig',
+        default: false,
+        type: 'boolean',
+      })
   },
   handler: async (argv: CLIArgs): Promise<void> => {
     return deploy(await loadEnv(argv), argv)

cli/commands/migrate.ts

@@ -74,7 +74,12 @@ export const migrate = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<vo
     // Get config and deploy contract
     const contractConfig = getContractConfig(graphConfig, cli.addressBook, name)
     const deployFn = contractConfig.proxy ? deployContractWithProxyAndSave : deployContractAndSave
-    const contract = await deployFn(name, contractConfig.params, cli.wallet, cli.addressBook)
+    const contract = await deployFn(
+      name,
+      contractConfig.params.map((a) => a.value), // keep only the values
+      cli.wallet,
+      cli.addressBook,
+    )
     logger.log('')
 
     // Defer contract calls after deploying every contract