Feature/metadata

README.md

@@ -175,6 +175,7 @@ to run `yarn test` or `yarn test:contracts`.
   - [Vue js modal](http://vue-js-modal.yev.io/)
   - [Ethers](https://docs.ethers.io/v5/)
   - [Gun](https://gun.eco/docs/)
+  - [GraphQL Code Generator](https://www.graphql-code-generator.com/docs/guides/vue) - used to generate the [/graphql/API.ts](https://github.com/clrfund/monorepo/blob/develop/vue-app/src/graphql/API.ts)
 
 ### Visual Studio Code
 

codegen.yml

@@ -1,5 +1,5 @@
 overwrite: true
-schema: 'http://localhost:8000/subgraphs/name/daodesigner/clrfund'
+schema: 'https://api.thegraph.com/subgraphs/name/clrfund/clrfund'
 documents: 'vue-app/src/graphql/**/*.graphql'
 generates:
   vue-app/src/graphql/API.ts:

contracts/.gitignore

@@ -6,3 +6,4 @@ state.json
 proofs.json
 tally.json
 .env
+.env.*

contracts/scripts/deploy.ts

@@ -3,6 +3,7 @@ import { Contract, utils } from 'ethers'
 
 import { UNIT } from '../utils/constants'
 import { deployMaciFactory } from '../utils/deployment'
+import { RecipientRegistryFactory } from '../utils/recipient-registry-factory'
 
 async function main() {
   const [deployer] = await ethers.getSigners()
@@ -59,30 +60,18 @@ async function main() {
   await setUserRegistryTx.wait()
 
   const recipientRegistryType = process.env.RECIPIENT_REGISTRY_TYPE || 'simple'
-  let recipientRegistry: Contract
-  if (recipientRegistryType === 'simple') {
-    const SimpleRecipientRegistry = await ethers.getContractFactory(
-      'SimpleRecipientRegistry',
-      deployer
-    )
-    recipientRegistry = await SimpleRecipientRegistry.deploy(
-      fundingRoundFactory.address
-    )
-  } else if (recipientRegistryType === 'optimistic') {
-    const OptimisticRecipientRegistry = await ethers.getContractFactory(
-      'OptimisticRecipientRegistry',
-      deployer
-    )
-    recipientRegistry = await OptimisticRecipientRegistry.deploy(
-      UNIT.div(1000),
-      0,
-      fundingRoundFactory.address
-    )
-  } else {
-    throw new Error('unsupported recipient registry type')
-  }
-  await recipientRegistry.deployTransaction.wait()
-  console.log(`Recipient registry deployed: ${recipientRegistry.address}`)
+  const recipientRegistry = await RecipientRegistryFactory.deploy(
+    recipientRegistryType,
+    {
+      controller: fundingRoundFactory.address,
+      baseDeposit: UNIT.div(1000),
+      challengePeriodDuration: 0,
+    },
+    deployer
+  )
+  console.log(
+    `${recipientRegistryType} recipient registry deployed: ${recipientRegistry.address}`
+  )
 
   const setRecipientRegistryTx = await fundingRoundFactory.setRecipientRegistry(
     recipientRegistry.address

contracts/scripts/deployRecipientRegistry.ts

@@ -0,0 +1,72 @@
+import { ethers } from 'hardhat'
+import { UNIT } from '../utils/constants'
+import { RecipientRegistryFactory } from '../utils/recipient-registry-factory'
+
+/*
+ * Deploy a new recipient registry.
+ * The following environment variables must be set to run the script
+ *
+ * RECIPIENT_REGISTRY_TYPE - default is simple, values can be simple, optimistic
+ * FUNDING_ROUND_FACTORY_ADDRESS - address of the funding round factory
+ * WALLET_PRIVATE_KEY - private key of the account that will fund this transaction
+ * JSONRPC_HTTP_URL - URL to connect to the node
+ *
+ * For example, to run the script on rinkeby network:
+ * From the contracts folder:
+ *    npx hardhat run --network rinkeby scripts/deployRecipientRegistry.ts
+ *
+ */
+async function main() {
+  const recipientRegistryType = process.env.RECIPIENT_REGISTRY_TYPE || 'simple'
+  const fundingRoundFactoryAddress = process.env.FUNDING_ROUND_FACTORY_ADDRESS
+  let challengePeriodDuration = '0'
+  let baseDeposit = '0'
+
+  if (recipientRegistryType === 'optimistic') {
+    challengePeriodDuration = process.env.CHALLENGE_PERIOD_IN_SECONDS || '300'
+    baseDeposit = process.env.BASE_DEPOSIT || UNIT.div(10).toString()
+  }
+
+  if (!fundingRoundFactoryAddress) {
+    console.log('Environment variable FUNDING_ROUND_FACTORY_ADDRESS not set')
+    return
+  }
+  const fundingRoundFactory = await ethers.getContractAt(
+    'FundingRoundFactory',
+    fundingRoundFactoryAddress
+  )
+  const factoryOwner = await fundingRoundFactory.owner()
+
+  console.log('*******************')
+  console.log(`Deploying a new ${recipientRegistryType} recipient registry!`)
+  console.log(` challenge period in seconds: ${challengePeriodDuration}`)
+  console.log(` baseDeposit: ${baseDeposit}`)
+  console.log(` fundingRoundFactoryAddress: ${fundingRoundFactoryAddress}`)
+  console.log(` fundingRoundFactoryOwner: ${factoryOwner}`)
+  const [deployer] = await ethers.getSigners()
+
+  const recipientRegistry = await RecipientRegistryFactory.deploy(
+    recipientRegistryType,
+    {
+      controller: fundingRoundFactory.address,
+      baseDeposit,
+      challengePeriodDuration,
+    },
+    deployer
+  )
+  console.log(` recipientRegistry address: ${recipientRegistry.address}`)
+
+  const setRecipientRegistryTx = await fundingRoundFactory.setRecipientRegistry(
+    recipientRegistry.address
+  )
+
+  await setRecipientRegistryTx.wait()
+  console.log('*******************')
+}
+
+main()
+  .then(() => process.exit(0))
+  .catch((error) => {
+    console.error(error)
+    process.exit(1)
+  })

contracts/scripts/deployRound.ts

@@ -3,8 +3,9 @@ import { Contract, utils } from 'ethers'
 import { Keypair } from 'maci-domainobjs'
 
 import { deployMaciFactory } from '../utils/deployment'
-import { getEventArg } from '../utils/contracts'
 import { MaciParameters } from '../utils/maci'
+import { RecipientRegistryFactory } from '../utils/recipient-registry-factory'
+import { RecipientRegistryLoader } from '../utils/recipient-registry-loader'
 
 async function main() {
   console.log('*******************')
@@ -63,30 +64,20 @@ async function main() {
   await setUserRegistryTx.wait()
 
   const recipientRegistryType = process.env.RECIPIENT_REGISTRY_TYPE || 'simple'
-  let recipientRegistry: Contract
-  if (recipientRegistryType === 'simple') {
-    const SimpleRecipientRegistry = await ethers.getContractFactory(
-      'SimpleRecipientRegistry',
-      deployer
-    )
-    recipientRegistry = await SimpleRecipientRegistry.deploy(
-      fundingRoundFactory.address
-    )
-  } else if (recipientRegistryType === 'optimistic') {
-    const OptimisticRecipientRegistry = await ethers.getContractFactory(
-      'OptimisticRecipientRegistry',
-      deployer
-    )
-    recipientRegistry = await OptimisticRecipientRegistry.deploy(
-      ethers.BigNumber.from(10).pow(ethers.BigNumber.from(18)).div(10),
-      300,
-      fundingRoundFactory.address
-    )
-  } else {
-    throw new Error('unsupported recipient registry type')
-  }
-  await recipientRegistry.deployTransaction.wait()
-  console.log('recipientRegistry.address: ', recipientRegistry.address)
+  const recipientRegistry = await RecipientRegistryFactory.deploy(
+    recipientRegistryType,
+    {
+      controller: fundingRoundFactory.address,
+      baseDeposit: ethers.BigNumber.from(10)
+        .pow(ethers.BigNumber.from(18))
+        .div(10),
+      challengePeriodDuration: 300,
+    },
+    deployer
+  )
+  console.log(
+    `${recipientRegistryType} recipientRegistry address: ${recipientRegistry.address}`
+  )
 
   const setRecipientRegistryTx = await fundingRoundFactory.setRecipientRegistry(
     recipientRegistry.address
@@ -122,47 +113,6 @@ async function main() {
   )
   await setMaciParametersTx.wait()
 
-  const metadataRecipient1 = {
-    name: 'Commons Simulator',
-    description:
-      'Funding open-source projects & other public goods is the killer app of blockchain tech. Giveth & BlockScience are joining forces to build the Commons Stack: a modular library of well engineered components that can be used to create economic models for projects that are creating value, yet have trouble finding sustainable business models.',
-    imageHash: 'QmbMP2fMiy6ek5uQZaxG3bzT9gSqMWxpdCUcQg1iSeEFMU',
-    tagline: 'Modeling Sustainable Funding for Public Good',
-    category: 'Data',
-    problemSpace: 'metadata.problemSpace',
-    plans: 'metadata.plans',
-    teamName: 'metadata.teamName',
-    teamDescription: 'metadata.teamDescription',
-    githubUrl: 'https://github.com/',
-    radicleUrl: 'https://radicle.xyz/',
-    websiteUrl: 'https://website.com/',
-    twitterUrl: 'https://twitter.com/',
-    discordUrl: 'https://discord.com/',
-    bannerImageHash: 'QmaDy75RkRVtZcbYeqMDLcCK8dDvahfik68zP7FbpxvD2F',
-    thumbnailImageHash: 'QmaDy75RkRVtZcbYeqMDLcCK8dDvahfik68zP7FbpxvD2F',
-  }
-
-  const metadataRecipient2 = {
-    name: 'Synthereum',
-    description:
-      'The aim of our synthetic assets is to help creating fiat-based wallet and applications on any local currencies, and help to create stock, commodities portfolio in order to bring more traditional users within the DeFi ecosystem.',
-    imageHash: 'QmbMP2fMiy6ek5uQZaxG3bzT9gSqMWxpdCUcQg1iSeEFMU',
-    tagline:
-      'Synthetic assets with liquidity pools to bridge traditional and digital finance.',
-    category: 'Content',
-    problemSpace: 'metadata.problemSpace',
-    plans: 'metadata.plans',
-    teamName: 'metadata.teamName',
-    teamDescription: 'metadata.teamDescription',
-    githubUrl: 'https://github.com/',
-    radicleUrl: 'https://radicle.xyz/',
-    websiteUrl: 'https://website.com/',
-    twitterUrl: 'https://twitter.com/',
-    discordUrl: 'https://discord.com/',
-    bannerImageHash: 'QmaDy75RkRVtZcbYeqMDLcCK8dDvahfik68zP7FbpxvD2F',
-    thumbnailImageHash: 'QmaDy75RkRVtZcbYeqMDLcCK8dDvahfik68zP7FbpxvD2F',
-  }
-
   const addFundingSourceTx = await fundingRoundFactory.addFundingSource(
     deployer.address
   )
@@ -172,79 +122,43 @@ async function main() {
   const deployNewRoundTx = await fundingRoundFactory.deployNewRound()
   await deployNewRoundTx.wait()
 
-  if (recipientRegistryType === 'simple') {
-    const recipients = [
-      { account: deployer.address, metadata: metadataRecipient1 },
-      { account: deployer.address, metadata: metadataRecipient2 },
-    ]
-    let addRecipientTx
-    for (const recipient of recipients) {
-      addRecipientTx = await recipientRegistry.addRecipient(
-        deployer.address,
-        JSON.stringify(recipient.metadata)
-      )
-      addRecipientTx.wait()
-    }
-  } else if (recipientRegistryType === 'optimistic') {
-    const deposit = await recipientRegistry.baseDeposit()
-    const recipient1Added = await recipientRegistry.addRecipient(
-      deployer.address,
-      JSON.stringify(metadataRecipient1),
-      { value: deposit }
-    )
-    await recipient1Added.wait()
-
-    const recipient1Id = await getEventArg(
-      recipient1Added,
-      recipientRegistry,
-      'RequestSubmitted',
-      '_recipientId'
-    )
-    const executeRequest1 = await recipientRegistry.executeRequest(recipient1Id)
-    await executeRequest1.wait()
-
-    const recipient2Added = await recipientRegistry.addRecipient(
-      deployer.address,
-      JSON.stringify(metadataRecipient2),
-      { value: deposit }
-    )
-    await recipient2Added.wait()
+  const recipients = RecipientRegistryLoader.buildStubRecipients([
+    deployer.address,
+    deployer.address,
+  ])
 
-    const recipient2Id = await getEventArg(
-      recipient2Added,
-      recipientRegistry,
-      'RequestSubmitted',
-      '_recipientId'
-    )
-    const executeRequest2 = await recipientRegistry.executeRequest(recipient2Id)
-    await executeRequest2.wait()
+  // add recipients to registry
+  await RecipientRegistryLoader.load(
+    recipientRegistryType,
+    recipientRegistry,
+    recipients
+  )
 
-    const fundingRoundAddress = await fundingRoundFactory.getCurrentRound()
-    console.log('fundingRound.address: ', fundingRoundAddress)
+  const fundingRoundAddress = await fundingRoundFactory.getCurrentRound()
+  console.log('fundingRound.address: ', fundingRoundAddress)
 
-    const fundingRound = await ethers.getContractAt(
-      'FundingRound',
-      fundingRoundAddress
+  const fundingRound = await ethers.getContractAt(
+    'FundingRound',
+    fundingRoundAddress
+  )
+  const maciAddress = await fundingRound.maci()
+  console.log('maci.address: ', maciAddress)
+
+  if (userRegistryType === 'brightid') {
+    const maci = await ethers.getContractAt('MACI', maciAddress)
+    const startTime = await maci.signUpTimestamp()
+    const endTime = await maci.calcSignUpDeadline()
+    const periodTx = await userRegistry.setRegistrationPeriod(
+      startTime,
+      endTime
     )
-    const maciAddress = await fundingRound.maci()
-    console.log('maci.address: ', maciAddress)
-
-    if (userRegistryType === 'brightid') {
-      const maci = await ethers.getContractAt('MACI', maciAddress)
-      const startTime = await maci.signUpTimestamp()
-      const endTime = await maci.calcSignUpDeadline()
-      const periodTx = await userRegistry.setRegistrationPeriod(
-        startTime,
-        endTime
-      )
-      console.log('Set user registration period', periodTx.hash)
-      await periodTx.wait()
-    }
-
-    console.log('*******************')
-    console.log('Deploy complete!')
-    console.log('*******************')
+    console.log('Set user registration period', periodTx.hash)
+    await periodTx.wait()
   }
+
+  console.log('*******************')
+  console.log('Deploy complete!')
+  console.log('*******************')
 }
 
 main()